org.starhope.vergil.graphics
Interface Container

public interface Container

A container of containers

Author:

brpocock@star-hope.org

Method Summary

Collection<Sprite>	getAllContainedSprites() WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)
Collection<Container>	getChildren() WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)
Container	getParent() WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)
Coord3D	getPosition()
Collection<Sprite>	getSprites() WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)
boolean	isVisible()
void	setPosition(Coord3D pos)
void	setVisible(boolean toBeSeen)

Method Detail

getAllContainedSprites

Collection<Sprite> getAllContainedSprites()

WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)

Returns:

all sprites contained by this container or its children

getChildren

Collection<Container> getChildren()

WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)

Returns:

all containers which are contained within this one

getParent

Container getParent()

WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)

Returns:

this container's parent container

getPosition

Coord3D getPosition()

Returns:

the position of this container relative to its parent; i.e. the coördinate space offset of this container from its parent's frame of reference

getSprites

Collection<Sprite> getSprites()

WRITEME: document this method (brpocock@star-hope.org, Jan 5, 2010)

Returns:

all sprites immediately contained by this container, excluding those contained by children

isVisible

boolean isVisible()

Returns:

true, if this container wants to be visible

setPosition

void setPosition(Coord3D pos)

Parameters:

pos - set the position of this container relative to its parent; i.e. the coördinate space offset of this container from its parent's frame of reference

setVisible

void setVisible(boolean toBeSeen)

Parameters:

toBeSeen - true, if you want this container to be potentially visible