Interface IBoundingBoxComponent

A component that calculates the bounding box of the entity. This is for both the bounding box used to render the entity, and for collision checks.

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(IModelMatrixComponent), true)]
[RequiredComponent(typeof(IImageComponent), true)]
[RequiredComponent(typeof(IDrawableInfoComponent), true)]
[RequiredComponent(typeof(IHasRoomComponent), true)]
[RequiredComponent(typeof(ICropSelfComponent), false)]
public interface IBoundingBoxComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

BoundingBoxLockStep

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

Declaration

ILockStep BoundingBoxLockStep { get; }

Property Value

Type	Description
ILockStep	The lock step.

OnBoundingBoxesChanged

An event which fires whenever the bounding boxes for the entity change.

Declaration

IBlockingEvent OnBoundingBoxesChanged { get; }

Property Value

Type	Description
IBlockingEvent	The on bounding boxes changed event.

WorldBoundingBox

Gets the entity's bounding box in world co-ordinates (can be used for hit-tests).

Declaration

AGSBoundingBox WorldBoundingBox { get; }

Property Value

Type	Description
AGSBoundingBox	The world bounding box.

Methods

GetBoundingBoxes(IViewport)

Gets the bounding boxes which surrounds the entity.

Declaration

AGSBoundingBoxes GetBoundingBoxes(IViewport viewport)

Parameters

Type	Name	Description
IViewport	viewport

Returns

Type	Description
AGSBoundingBoxes	The bounding boxes.