Aurora::GFXControl Class Reference

A control tag is used for controlling stuff in the scene, like placing or removing objects, and stopping at every frame. More...

#include <gfxfile.h>

Classes
struct	ColorTransform
	A color tranformation of the specific object. More...
struct	DoAction
	A do action control tag. More...
struct	PlaceObject
	A place object control tag for placing objects. More...

Public Types
enum	ControlType { kShowFrame, kPlaceObject, kDoAction }
	The possible control types. More...

Public Member Functions
ControlType	getType () const
	Get the type of this control. More...
void	getPlaceObject (PlaceObject &placeObject) const
	Get the place object control. More...
void	getDoAction (DoAction &doAction) const
	Get do action control. More...

Static Public Member Functions
static GFXControl	createPlaceObject (PlaceObject)
	Create a place object control. More...
static GFXControl	createDoAction (DoAction)
	Create a do action control. More...
static GFXControl	createShowFrame ()
	Create a show frame control. More...

Private Member Functions
	GFXControl (ControlType type)

Private Attributes
boost::variant< PlaceObject, DoAction >	_value
ControlType	_type

Detailed Description

A control tag is used for controlling stuff in the scene, like placing or removing objects, and stopping at every frame.

Definition at line 278 of file gfxfile.h.

Member Enumeration Documentation

ControlType

enum Aurora::GFXControl::ControlType

The possible control types.

Enumerator
kShowFrame
kPlaceObject
kDoAction

Definition at line 283 of file gfxfile.h.

Constructor & Destructor Documentation

GFXControl()

Aurora::GFXControl::GFXControl ( ControlType  type )

explicitprivate

Definition at line 195 of file gfxfile.cpp.

Referenced by createShowFrame().

Here is the caller graph for this function:

Member Function Documentation

createDoAction()

GFXControl Aurora::GFXControl::createDoAction ( DoAction  doAction )

static

Create a do action control.

Definition at line 169 of file gfxfile.cpp.

References _value, and kDoAction.

Referenced by Aurora::GFXFile::load(), and Aurora::GFXFile::readDefineSprite().

Here is the caller graph for this function:

createPlaceObject()

GFXControl Aurora::GFXControl::createPlaceObject ( PlaceObject  placeObject )

static

Create a place object control.

Definition at line 161 of file gfxfile.cpp.

References _value, and kPlaceObject.

Referenced by Aurora::GFXFile::readPlaceObject().

Here is the caller graph for this function:

createShowFrame()

GFXControl Aurora::GFXControl::createShowFrame ( )

static

Create a show frame control.

Definition at line 177 of file gfxfile.cpp.

References GFXControl(), and kShowFrame.

Referenced by Aurora::GFXFile::load(), and Aurora::GFXFile::readDefineSprite().

Here is the call graph for this function:

Here is the caller graph for this function:

getDoAction()

void Aurora::GFXControl::getDoAction

(

DoAction &

doAction

)

const

Get do action control.

Definition at line 188 of file gfxfile.cpp.

References _type, _value, and kDoAction.

getPlaceObject()

void Aurora::GFXControl::getPlaceObject

(

PlaceObject &

placeObject

)

const

Get the place object control.

Definition at line 181 of file gfxfile.cpp.

References _type, _value, and kPlaceObject.

getType()

ControlType Aurora::GFXControl::getType ( ) const

inline

Get the type of this control.

Definition at line 328 of file gfxfile.h.

References _type.

Member Data Documentation

_type

ControlType Aurora::GFXControl::_type

private

Definition at line 338 of file gfxfile.h.

Referenced by getDoAction(), getPlaceObject(), and getType().

_value

boost::variant<PlaceObject, DoAction> Aurora::GFXControl::_value

private

Definition at line 336 of file gfxfile.h.

Referenced by createDoAction(), createPlaceObject(), getDoAction(), and getPlaceObject().

---

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

• src/aurora/gfxfile.h
• src/aurora/gfxfile.cpp