GlsMutexGroup Class Reference

Inheritance diagram for GlsMutexGroup:

Public Member Functions
	GlsMutexGroup ()
	GlsMutexGroup (DisplayObjectArray *objs)
int	MutexState (None)
None	MutexState (int state)
int	State (None)
None	State (int state)
bool	CalculateInvisibleStates (None)
None	CalculateInvisibleStates (bool value)
bool	PickInvisibleStates (None)
None	PickInvisibleStates (bool value)
bool	PreDrawInvisibleStates (None)
None	PreDrawInvisibleStates (bool value)
bool	InputDeviceBehavior (None)
None	InputDeviceBehavior (bool value)
Public Member Functions inherited from Group
	Group ()
	Group (DisplayObjectArray *objs)
None	Ungroup ()
None	InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)
None	InsertObjectAllowDuplicateNames (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)
None	MoveObjectToGroup (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)
None	MoveObjectToGroupAllowDuplicateNames (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)
None	ReorderObject (int oldIndex, int newIndex)
DisplayObjectArray *	GetObjectList ()
DisplayObject *	GetObjectByIndex (int index)
int	Count ()
None	CalculateTextureCoordinates (None)
None	SetGroupLocation (Vertex &v)
None	CalculateBoundingBox ()
int	GetCount ()
Public Member Functions inherited from DisplayObject
bool	isNULL ()
str	GetName ()
str	SetName (str name)
None	SetProtectionMode (DisplayObject::MemberAccess_e mode)
DisplayObject::MemberAccess_e	GetProtectionMode (None)
None	SetLocked (bool val)
bool	GetLocked (None)
bool	GetGenerateMemberVariable ()
None	SetGenerateMemberVariable (bool b)
bool	GetAntiAliasing ()
None	SetAntiAliasing (bool antiAliasing)
bool	GetBlinking ()
None	SetBlinking (bool blinking)
float	GetBlinkRate ()
None	SetBlinkRate (float rate)
int	GetAlphaMode ()
None	SetAlphaMode (int mode)
bool	GetCullBackFaces ()
None	SetCullBackFaces (bool cullFaces)
bool	GetZBufferTestedFlag ()
None	SetZBufferTestedFlag (bool tested)
bool	GetAffectZBufferFlag ()
None	SetAffectZBufferFlag (bool affect)
bool	GetLightingEnabledFlag ()
None	SetLightingEnabledFlag (bool enabled)
DisplayObject::PickableType_e	GetPickMode ()
None	SetPickMode (DisplayObject::PickableType_e mode)
bool	GetVisibilityFlag ()
None	SetVisibilityFlag (bool visible)
PolygonClose_e	GetClosePolygonFlag ()
None	SetClosePolygonFlag (PolygonClose_e closePolygon)
PolygonMode_e	GetPolygonMode ()
None	SetPolygonMode (PolygonMode_e polygonMode)
ShadingType_e	GetShadingMode ()
None	SetShadingMode (ShadingType_e shadingMode)
Vertex	GetLocation ()
None	SetLocation (Vertex loc)
Vertex	GetRotationPoint ()
None	SetRotationPoint (Vertex rotPoint)
GlsMatrixAffine *	GetDcsMatrix ()
None	SetDcsMatrix (GlsMatrixAffine *matrix)
int	GetMaterialIndex ()
None	SetMaterialIndex (int matIndex)
str	GetObjectClassName ()
int	GetTextureIndex ()
None	SetTextureIndex (int texIndex)
TextureMap_e	GetTextureMappingTechnique ()
None	SetTextureMappingTechnique (TextureMap_e mappingTechnique)
bool	GetTextureRepeat ()
None	SetTextureRepeat (bool repeat)
disti::GlsColor	GetBlendingColor ()
None	SetBlendingColor (GlsColor blendColor)
DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()
None	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)
DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()
None	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)
list	GetTextureCoordinates ()
None	SetTextureCoordinates (list &texVerts)
None	GetTextureCoordinates (VertexArray *texVerts)
None	SetTextureCoordinates (VertexArray &texVerts)
None	GetTexturePoints (VertexArray *texVerts)
None	SetTexturePoints (VertexArray &texVerts)
None	SetTexturePoints (list &texVerts)
list	GetTexturePoints ()
None	GetVertices (VertexArray *verts)
None	SetVertices (VertexArray &verts)
str	GetInitialization ()
None	SetInitialization (str initCode)
str	GetCallbackCode ()
None	SetCallbackCode (str cbCode)
DisplayObject *	DuplicateObject (Document *doc=NULL)
DisplayObject *	TessellateObject ()
DisplayObject *	ExtrudeObject (float amount)
None	RotateObject (float amount, RotationAxis_e axis)
None	TranslateObject (float x, float y, float z)
None	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)
None	LineWidth (float width)
float	LineWidth ()
LineStyle_e	LineStyle ()
None	LineStyle (LineStyle_e style)
GlsColor	LineColor ()
None	LineColor (GlsColor color)
GlsColor	FillColor ()
None	FillColor (GlsColor color)
None	GetExtents (Vector &min, Vector &max)
bool	HasUserDefinedAttribute (str attribName)
std::map< str, str >	GetUserDefinedAttributes ()
UserDefinedValueAttributeList	GetAllUserDefinedAttributes ()
str	GetUserDefinedAttributeValue (str attribName)
	typemap (check) str attribName
None	SetUserDefinedAttributeValue (str attribName, str value)
DisplayObject *	GetParent ()
Document *	GetDocument ()
str	AlternateClassName ()
None	AlternateClassName (str name)
str	GetAlternateClassHeaderFile ()
None	SetAlternateClassHeaderFile (str name)
str	GetResources ()
str	GetRuntimeResources (bool recursive)
str	GetAttributeType (str attribName)
str	GetAttributeValuestr (str attribName)
None	SetAttributeValuestr (str attribName, str value)
int	RegisterObserver (str attribName, PyObject *pyfunc)
None	UnregisterObserver (str attribName, int id)
list	GetNormals ()
None	SetNormals (list &normals)
list	GetExtraAttributes ()
DisplayObject *	CloneObject ()
None	CopyProperties (DisplayObject *sourceObj)
None	SetLocation (Vector loc)
GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)
None	CalculateParentBoundingBox ()
None	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() [1/2]

GlsMutexGroup::GlsMutexGroup

(

)

Creates an empty mutex group.

GlsMutexGroup() [2/2]

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

CalculateInvisibleStates() [1/2]

None 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

CalculateInvisibleStates() [2/2]

bool GlsMutexGroup::CalculateInvisibleStates

(

None

)

Returns

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

CastToGlsMutexGroup()

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

InputDeviceBehavior() [1/2]

None GlsMutexGroup::InputDeviceBehavior

(

bool

value

)

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

Parameters

value

True = InputDevice, False = MutexGroup

InputDeviceBehavior() [2/2]

bool GlsMutexGroup::InputDeviceBehavior

(

None

)

Returns

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

MutexState() [1/2]

None 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

MutexState() [2/2]

int GlsMutexGroup::MutexState

(

None

)

Returns

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

PickInvisibleStates() [1/2]

None 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

PickInvisibleStates() [2/2]

bool GlsMutexGroup::PickInvisibleStates

(

None

)

Returns

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

PreDrawInvisibleStates() [1/2]

None 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

PreDrawInvisibleStates() [2/2]

bool GlsMutexGroup::PreDrawInvisibleStates

(

None

)

Returns

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

State() [1/2]

None GlsMutexGroup::State

(

int

state

)

Sets the InputDevice state of this group.

Parameters

state

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

State() [2/2]

int GlsMutexGroup::State

(

None

)

Returns

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

---

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

• GlsMutexGroup.i