Inheritance diagram for GlsMutexGroup:

Public Member Functions
	GlsMutexGroup ()

	GlsMutexGroup (DisplayObjectArray *objs)

int	MutexState (void)

void	MutexState (int state)

int	State (void)

void	State (int state)

bool	CalculateInvisibleStates (void)

void	CalculateInvisibleStates (bool value)

bool	PickInvisibleStates (void)

void	PickInvisibleStates (bool value)

bool	PreDrawInvisibleStates (void)

void	PreDrawInvisibleStates (bool value)

bool	InputDeviceBehavior (void)

void	InputDeviceBehavior (bool value)

Public Member Functions inherited from Group
	Group ()

	Group (DisplayObjectArray *objs)

void	Ungroup ()

void	InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)

void	InsertObjectAllowDuplicateNames (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)

void	MoveObjectToGroup (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)

void	MoveObjectToGroupAllowDuplicateNames (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)

void	ReorderObject (unsigned int oldIndex, unsigned int newIndex)

DisplayObjectArray *	GetObjectList ()

DisplayObject *	GetObjectByIndex (unsigned int index)

unsigned int	Count (void)

void	CalculateTextureCoordinates (void)

void	SetGroupLocation (Vertex &v)

void	CalculateBoundingBox ()

unsigned int	GetCount ()

Public Member Functions inherited from DisplayObject
bool	isNULL (void)

String	GetName ()

String	SetName (String name)

void	SetProtectionMode (DisplayObject::MemberAccess_e mode)

DisplayObject::MemberAccess_e	GetProtectionMode (void)

void	SetLocked (bool val)

bool	GetLocked (void)

bool	GetGenerateMemberVariable ()

void	SetGenerateMemberVariable (bool b)

bool	GetAntiAliasing ()

void	SetAntiAliasing (bool antiAliasing)

bool	GetBlinking ()

void	SetBlinking (bool blinking)

float	GetBlinkRate ()

void	SetBlinkRate (float rate)

int	GetAlphaMode ()

void	SetAlphaMode (int mode)

bool	GetCullBackFaces ()

void	SetCullBackFaces (bool cullFaces)

bool	GetZBufferTestedFlag ()

void	SetZBufferTestedFlag (bool tested)

bool	GetAffectZBufferFlag ()

void	SetAffectZBufferFlag (bool affect)

bool	GetLightingEnabledFlag ()

void	SetLightingEnabledFlag (bool enabled)

DisplayObject::PickableType_e	GetPickMode ()

void	SetPickMode (DisplayObject::PickableType_e mode)

bool	GetVisibilityFlag ()

void	SetVisibilityFlag (bool visible)

PolygonClose_e	GetClosePolygonFlag ()

void	SetClosePolygonFlag (PolygonClose_e closePolygon)

PolygonMode_e	GetPolygonMode ()

void	SetPolygonMode (PolygonMode_e polygonMode)

ShadingType_e	GetShadingMode ()

void	SetShadingMode (ShadingType_e shadingMode)

Vertex	GetLocation ()

void	SetLocation (Vertex loc)

Vertex	GetRotationPoint ()

void	SetRotationPoint (Vertex rotPoint)

GlsMatrixAffine *	GetDcsMatrix ()

void	SetDcsMatrix (GlsMatrixAffine *matrix)

int	GetMaterialIndex ()

void	SetMaterialIndex (int matIndex)

String	GetObjectClassName ()

int	GetTextureIndex ()

void	SetTextureIndex (int texIndex)

TextureMap_e	GetTextureMappingTechnique ()

void	SetTextureMappingTechnique (TextureMap_e mappingTechnique)

bool	GetTextureRepeat ()

void	SetTextureRepeat (bool repeat)

disti::GlsColor	GetBlendingColor ()

void	SetBlendingColor (GlsColor blendColor)

DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()

void	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)

DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()

void	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)

std::vector< Vector >	GetTextureCoordinates ()

void	SetTextureCoordinates (std::vector< Vector > &texVerts)

void	GetTextureCoordinates (VertexArray *texVerts)

void	SetTextureCoordinates (VertexArray &texVerts)

void	GetTexturePoints (VertexArray *texVerts)

void	SetTexturePoints (VertexArray &texVerts)

void	SetTexturePoints (std::vector< Vector > &texVerts)

std::vector< Vector >	GetTexturePoints ()

void	GetVertices (VertexArray *verts)

void	SetVertices (VertexArray &verts)

String	GetInitialization ()

void	SetInitialization (String initCode)

String	GetCallbackCode ()

void	SetCallbackCode (String cbCode)

DisplayObject *	DuplicateObject (Document *doc=NULL)

DisplayObject *	TessellateObject ()

DisplayObject *	ExtrudeObject (float amount)

void	RotateObject (float amount, RotationAxis_e axis)

void	TranslateObject (float x, float y, float z)

void	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)

void	LineWidth (float width)

float	LineWidth ()

LineStyle_e	LineStyle ()

void	LineStyle (LineStyle_e style)

GlsColor	LineColor ()

void	LineColor (GlsColor color)

GlsColor	FillColor ()

void	FillColor (GlsColor color)

void	GetExtents (Vector &min, Vector &max)

bool	HasUserDefinedAttribute (String attribName)

std::map< String, String >	GetUserDefinedAttributes ()

UserDefinedValueAttributeList	GetAllUserDefinedAttributes ()

String	GetUserDefinedAttributeValue (String attribName)

	typemap (check) String attribName

void	SetUserDefinedAttributeValue (String attribName, String value)

DisplayObject *	GetParent ()

Document *	GetDocument ()

String	AlternateClassName ()

void	AlternateClassName (String name)

String	GetAlternateClassHeaderFile ()

void	SetAlternateClassHeaderFile (String name)

String	GetResources ()

String	GetRuntimeResources (bool recursive)

String	GetAttributeValueString (String attribName)

void	SetAttributeValueString (String attribName, String value)

unsigned int	RegisterObserver (String attribName, PyObject *pyfunc)

void	UnregisterObserver (String attribName, unsigned int id)

std::vector< Vector >	GetNormals ()

void	SetNormals (std::vector< Vector > &normals)

std::vector< CustomAttributeInfo >	GetExtraAttributes ()

DisplayObject *	CloneObject ()

void	CopyProperties (DisplayObject *sourceObj)

void	SetLocation (Vector loc)

GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)

void	CalculateParentBoundingBox ()

void	SetOrigin (Vertex &vert)

Static Public Member Functions
static GlsMutexGroup *	CastToGlsMutexGroup (DisplayObject *obj)

Static Public Member Functions inherited from Group
static Group *	CastToGroup (DisplayObject *obj)

Additional Inherited Members
Public Types inherited from DisplayObject
enum	MemberAccess_e { PUBLIC, PRIVATE, PROTECTED }

enum	PickableType_e { UNPICKABLE, FIRST_PICK, BEST_PICK, ALWAYS_PICK }

enum	PolygonClose_e { POLY_OPEN, POLY_CLOSED }

enum	PolygonMode_e { POLY_MODE_UNDEFINED, POLY_MODE_POINTS, POLY_MODE_OUTLINE, POLY_MODE_FILLED, POLY_MODE_FILL_AND_OUTLINE }

enum	ShadingType_e { SHADING_FLAT, SHADING_GOURAUD }

enum	TextureMap_e { TEXTURE_MAP_MODULATE, TEXTURE_MAP_DECAL, TEXTURE_MAP_BLEND, TEXTURE_MAP_REPLACE }

enum	TextureFilter_e { TEXTURE_FILTER_NEAREST, TEXTURE_FILTER_LINEAR, TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST, TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR, TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR, TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST }

enum	TessellateType_e { TESSELLATE_UNION, TESSELLATE_INTERSECT, TESSELLATE_DIFFERENCE }

enum	RotationAxis_e { X_AXIS, Y_AXIS, Z_AXIS }

enum	LineStyle_e { SOLID_LINE_STYLE, SMALL_DOTTED_LINE_STYLE, DOTTED_LINE_STYLE, DASHED_LINE_STYLE, DOT_DASHED_LINE_STYLE, SMALL_DASHED_LINE_STYLE }

enum	AlphaMode_e { ALPHA_MODE_UNDEFINED, ALPHA_MODE_OPAQUE, ALPHA_MODE_2_LEVEL, ALPHA_MODE_256_LEVEL }

Static Public Attributes inherited from Group
static int	DEFAULT_GROUP_LOCATION = -1

Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

Plug-in used to create a group of objects whose visibility are mutually exclusive, i.e.

only one of the objects in the group is visible at any given time.

Constructor & Destructor Documentation

GlsMutexGroup::GlsMutexGroup ( )

Creates an empty mutex group.

GlsMutexGroup::GlsMutexGroup ( DisplayObjectArray * objs )

Creates a mutex group initialized with the given array of objects.

Parameters

objs	array of objects to initialize group with

Member Function Documentation

bool GlsMutexGroup::CalculateInvisibleStates ( void )

Returns: The calculate option of this group, true = calculate all objects, false = calculate active object only

void GlsMutexGroup::CalculateInvisibleStates ( bool value )

Sets the calculate option of this group.

Parameters

value The new calculate option, true = calculate all objects, false = calculate active object only

static GlsMutexGroup* GlsMutexGroup::CastToGlsMutexGroup ( DisplayObject * obj )

static

Casts the Display Object as a GlsMutexGroup NOTE: perform an isNULL check on the returned value to ensure the cast was accomplished.

Parameters

obj	objects to cast

Returns: GlsMutexGroup the GlsMutexGroup

Exceptions

CEIException

bool GlsMutexGroup::InputDeviceBehavior ( void )

Returns: Simulate the legacy InputDevice behavior, where state 0 is always shown and the state is one-based.

void GlsMutexGroup::InputDeviceBehavior ( bool value )

Sets the simulation of legacy InputDevice behavior, where state 0 is always shown.

Parameters

value True = InputDevice, False = MutexGroup

int GlsMutexGroup::MutexState ( void )

Returns: The mutex state (active object index) of this group, -1 = no object is visible / active

void GlsMutexGroup::MutexState ( int state )

Sets the mutex state (active object index) of this group, -1 = none.

Parameters

state The new mutex state, valid values are -1, and 0 to Count() - 1

bool GlsMutexGroup::PickInvisibleStates ( void )

Returns: The picking option of this group, true = pick all objects, false = pick active object only

void GlsMutexGroup::PickInvisibleStates ( bool value )

Sets the picking option of this group.

Parameters

value The new picking option, true = pick all objects, false = pick active object only

bool GlsMutexGroup::PreDrawInvisibleStates ( void )

Returns: The predraw option of this group, true = predraw all objects, false = predraw active object only

void GlsMutexGroup::PreDrawInvisibleStates ( bool value )

Sets the predraw option of this group.

Parameters

value The new predraw option, true = predraw all objects, false = predraw active object only

int GlsMutexGroup::State ( void )

Returns: The InputDevice state of this group, valid values are 1 to Count()

void GlsMutexGroup::State ( int state )

Sets the InputDevice state of this group.

Parameters

state The new InputDevice state, valid values are 1 to Count()

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

GlsMutexGroup.i

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation