Interface IBoundingBoxWithChildrenComponent

Allows to query the size of the entity combined with all its children (i.e the size of the minimal bounding box that surrounds them all).

Inherited Members

IComponent.Name

IComponent.Entity

IComponent.RegistrationType

IComponent.Init(IEntity, Type)

IComponent.AfterInit()

System.IDisposable.Dispose()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

[RequiredComponent(typeof(IBoundingBoxComponent), true)]
[RequiredComponent(typeof(IInObjectTreeComponent), true)]
public interface IBoundingBoxWithChildrenComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

| Improve this Doc View Source

BoundingBoxWithChildren

Gets the bounding box which wraps around the entity and all its children.

Declaration

AGSBoundingBox BoundingBoxWithChildren { get; }

Property Value

Type	Description
AGSBoundingBox	The size with children.

| Improve this Doc View Source

EntitiesToSkip

Allows excluding entities from the bounding box calculation.

Declaration

IConcurrentHashSet<string> EntitiesToSkip { get; }

Property Value

Type	Description
IConcurrentHashSet<System.String>	The entities to skip.

| Improve this Doc View Source

IncludeSelf

Gets or sets a value indicating whether the bounding box calculation includes the entity's size as well (true by default).

Declaration

bool IncludeSelf { get; set; }

Property Value

Type	Description
System.Boolean	`true` if include self; otherwise, `false`.

| Improve this Doc View Source

LockStep

Allows locking the component from changing (to allow for changing multiple components "at once").

Declaration

ILockStep LockStep { get; }

Property Value

Type	Description
ILockStep	The lock step.

| Improve this Doc View Source

OnBoundingBoxWithChildrenChanged

An event which fires whenever the bounding box with children changes.

Declaration

IBlockingEvent OnBoundingBoxWithChildrenChanged { get; }

Property Value

Type	Description
IBlockingEvent	The on bounding box with children changed.

| Improve this Doc View Source

PreCropBoundingBoxWithChildren

Gets the bounding box which wraps around the entity and all its children before any of the children was cropped (for entities which has the ICropSelfComponent attached to them.

Declaration

AGSBoundingBox PreCropBoundingBoxWithChildren { get; }

Property Value

Type	Description
AGSBoundingBox	The pre crop bounding box with children.