Gondwana.Drawing.Sprites.CompositeSprite Class Reference

Represents a composite sprite that contains multiple child sprites and manages them as a single unit. All child sprites must belong to the same SceneLayer. More...

Inheritance diagram for Gondwana.Drawing.Sprites.CompositeSprite:

Public Member Functions
	CompositeSprite ()
	Initializes a new instance of the CompositeSprite class.
	CompositeSprite (List< Sprite > sprites)
	Initializes a new instance of the CompositeSprite class with the specified list of sprites.
	CompositeSprite (params Sprite[] sprites)
	Initializes a new instance of the CompositeSprite class with the specified array of sprites.
Vector2	GetPosition ()
	Gets the current position of the composite sprite based on its anchor mode.
void	SetPosition (Vector2 pos)
	Sets the position of the composite sprite by moving all child sprites to maintain their relative positions.
void	Translate (Vector2 delta)
	Translates the composite sprite by the specified delta vector.
void	Add (Sprite sprite)
	Adds an existing sprite at its current position (no reposition).
void	AddChildAtPosition (Sprite sprite, Vector2 absolutePosition)
	Add a sprite and place it at an absolute position (in the composite's PositionSpace).
void	AddChildWithOffset (Sprite sprite, Vector2 offsetFromCompositeAnchor)
	Add a sprite and place it by offset from the composite anchor. Offset is interpreted relative to the CURRENT composite anchor (derived from Range).
void	Remove (Sprite sprite)
	Removes a sprite from this composite.

Properties
CompositeAnchorMode	AnchorMode = CompositeAnchorMode.TopLeft [get, set]
	Gets or sets the anchor mode that determines how the composite's position is calculated relative to its children.
MovementSpace	PositionSpace [get]
	Gets the movement space used for positioning this composite sprite.
SceneLayer	SceneLayer [get]
	Gets the scene layer that all child sprites belong to.
ReadOnlyCollection< Sprite >	Children [get]
	Gets a read-only collection of all child sprites in this composite.
Rectangle	Range [get]
	Gets the bounding rectangle that encompasses all child sprites. Returns Rectangle.Empty if there are no children.

Detailed Description

Represents a composite sprite that contains multiple child sprites and manages them as a single unit. All child sprites must belong to the same SceneLayer.

Constructor & Destructor Documentation

CompositeSprite() [1/3]

Gondwana.Drawing.Sprites.CompositeSprite.CompositeSprite

(

)

Initializes a new instance of the CompositeSprite class.

CompositeSprite() [2/3]

Gondwana.Drawing.Sprites.CompositeSprite.CompositeSprite

(

List< Sprite >

sprites

)

Initializes a new instance of the CompositeSprite class with the specified list of sprites.

Parameters

sprites

The list of sprites to add to this composite.

CompositeSprite() [3/3]

Gondwana.Drawing.Sprites.CompositeSprite.CompositeSprite

(

params Sprite[]

sprites

)

Initializes a new instance of the CompositeSprite class with the specified array of sprites.

Parameters

sprites

The array of sprites to add to this composite.

Member Function Documentation

Add()

void Gondwana.Drawing.Sprites.CompositeSprite.Add

(

Sprite

sprite

)

Adds an existing sprite at its current position (no reposition).

Parameters

sprite

The sprite to add to this composite.

Exceptions

ArgumentNullException	Thrown when sprite is null.
InvalidOperationException	Thrown when the sprite belongs to a different SceneLayer than existing children.

AddChildAtPosition()

void Gondwana.Drawing.Sprites.CompositeSprite.AddChildAtPosition	(	Sprite	sprite,
		Vector2	absolutePosition )

Add a sprite and place it at an absolute position (in the composite's PositionSpace).

Parameters

sprite	The sprite to add to this composite.
absolutePosition	The absolute position to place the sprite at.

Exceptions

ArgumentNullException	Thrown when sprite is null.
InvalidOperationException	Thrown when the sprite belongs to a different SceneLayer than existing children.

AddChildWithOffset()

void Gondwana.Drawing.Sprites.CompositeSprite.AddChildWithOffset	(	Sprite	sprite,
		Vector2	offsetFromCompositeAnchor )

Add a sprite and place it by offset from the composite anchor. Offset is interpreted relative to the CURRENT composite anchor (derived from Range).

Parameters

sprite	The sprite to add to this composite.
offsetFromCompositeAnchor	The offset from the composite's anchor point.

Exceptions

ArgumentNullException	Thrown when sprite is null.
InvalidOperationException	Thrown when the sprite belongs to a different SceneLayer than existing children.

GetPosition()

Vector2 Gondwana.Drawing.Sprites.CompositeSprite.GetPosition

(

)

Gets the current position of the composite sprite based on its anchor mode.

Returns

The position of the composite's anchor point.

Implements Gondwana.Movement.IMovable.

Remove()

void Gondwana.Drawing.Sprites.CompositeSprite.Remove

(

Sprite

sprite

)

Removes a sprite from this composite.

Parameters

sprite

The sprite to remove.

SetPosition()

void Gondwana.Drawing.Sprites.CompositeSprite.SetPosition

(

Vector2

pos

)

Sets the position of the composite sprite by moving all child sprites to maintain their relative positions.

Parameters

pos	The new position for the composite's anchor point.

Implements Gondwana.Movement.IMovable.

Translate()

void Gondwana.Drawing.Sprites.CompositeSprite.Translate

(

Vector2

delta

)

Translates the composite sprite by the specified delta vector.

Parameters

delta

The translation vector to apply.

Property Documentation

AnchorMode

CompositeAnchorMode Gondwana.Drawing.Sprites.CompositeSprite.AnchorMode = CompositeAnchorMode.TopLeft

getset

Gets or sets the anchor mode that determines how the composite's position is calculated relative to its children.

Children

ReadOnlyCollection<Sprite> Gondwana.Drawing.Sprites.CompositeSprite.Children

get

Gets a read-only collection of all child sprites in this composite.

PositionSpace

MovementSpace Gondwana.Drawing.Sprites.CompositeSprite.PositionSpace

get

Gets the movement space used for positioning this composite sprite.

Implements Gondwana.Movement.IMovable.

Range

Rectangle Gondwana.Drawing.Sprites.CompositeSprite.Range

get

Gets the bounding rectangle that encompasses all child sprites. Returns Rectangle.Empty if there are no children.

SceneLayer

SceneLayer Gondwana.Drawing.Sprites.CompositeSprite.SceneLayer

get

Gets the scene layer that all child sprites belong to.

Exceptions

InvalidOperationException

Thrown when the composite has no children.

Implements Gondwana.Movement.IMovableOnSceneLayer.