1. Home
  2. Documentation
  3. API
  4. UIContainer Class Reference

UIContainer Class Reference

#include <UIContainer.h>

Inheritance diagram for UIContainer:
Container

# Public Member Functions

void constructor (PositionedActor *childrenPositionedActors)
override void transform (const Transformation *environmentTransform, uint8 invalidateTransformationFlag)
Actor spawnChildActor (const PositionedActor *const positionedActor)

# Additional Inherited Members

- Private Member Functions inherited from Container
void constructor (int16 internalId, const char *const name)
override void setDirection (const Vector3D *direction)
override void show ()
 Make this instance visible.
override void hide ()
 Make this instance invisible.
override void setTransparency (uint8 transparency)
override void setPosition (const Vector3D *position)
override void setRotation (const Rotation *rotation)
override void setScale (const Scale *scale)
void setNormalizedDirection (NormalizedDirection normalizedDirection)
NormalizedDirection getNormalizedDirection ()
void deleteMyself ()
int16 getInternalId ()
void setName (const char *const name)
const char * getName ()
void streamOut (bool streamOut)
Container getParent ()
void addChild (Container child)
void removeChild (Container child, bool deleteChild)
void purgeChildren ()
 Force the destruction of all children marked to be deleted.
bool getChildren (ClassPointer classPointer, VirtualList children)
Container getChildById (int16 id)
Container getChildByName (const char *childName, bool recursive)
Container getChildAtPosition (int16 position)
int32 getChildrenCount ()
Container getFirstAncestor ()
Container getRelativeByName (const char *relativeName)
void updateChildren ()
 Update the children of this container.
void invalidateTransformation ()
void transformChildren (uint8 invalidateTransformationFlag)
void propagateCommand (uint32 command,...)
bool propagateMessage (bool(*propagatedMessageHandler)(void *, va_list),...)
bool onPropagatedMessage (va_list args)
bool propagateString (bool(*propagatedMessageHandler)(void *, va_list),...)
bool onPropagatedString (va_list args)
void translate (const Vector3D *translation)
void rotate (const Rotation *rotation)
void scale (const Scale *scale)
const Vector3D * getLocalPosition ()
const Rotation * getLocalRotation ()
const Scale * getLocalScale ()
virtual void setLocalPosition (const Vector3D *position)
virtual void setLocalRotation (const Rotation *rotation)
virtual void setLocalScale (const Scale *scale)
virtual void ready (bool recursive)
virtual void update ()
 Update this instance's logic.
virtual void suspend ()
 Prepare to suspend this instance's logic.
virtual void resume ()
 Prepare to resume this instance's logic.
virtual void handleCommand (int32 command, va_list args)
virtual bool handlePropagatedMessage (int32 message)
virtual bool handlePropagatedString (const char *string)
- Private Attributes inherited from Container
Container parent
 Container of which this one is a child.
VirtualList children
Transformation localTransformation
 3D local transformation
char * name
 Container's name.
int16 internalId
 Container's internal id, set by the engine.
bool deleteMe
 If true, the parent will delete this container when appropriate.
bool ready
bool dontStreamOut
bool hidden
 Flag to mark the container (and its children) as non visible.
int8 axisForSynchronizationWithBody
 Axises around which to rotate the container when syncronizing with body.

# Detailed Description

Class UIContainer

Inherits from Container

Implements a container whose children are always fixed to the camera

Definition at line 29 of file UIContainer.h.

# Member Function Documentation

# constructor()

void UIContainer::constructor ( PositionedActor * childrenPositionedActors)

Class' constructor

Parameters
childrenPositionedActorsArray of specs that define how to configure the container's children

Definition at line 26 of file UIContainer.c.

# spawnChildActor()

Actor UIContainer::spawnChildActor ( const PositionedActor *const positionedActor)

Spawn a new child and configure it with the provided positioned actor struct.

Parameters
positionedActorStruct that defines which actor spec to use to configure the new child

Definition at line 63 of file UIContainer.c.

# transform()

void UIContainer::transform ( const Transformation * environmentTransform,
uint8 invalidateTransformationFlag )
virtual

Compute the container's global transformation.

Parameters
environmentTransformReference environment for the local transformation
invalidateTransformationFlagFlag that determines which transfomation's components must be recomputed

Reimplemented from Container.

Definition at line 49 of file UIContainer.c.


The documentation for this class was generated from the following files: