GlsMimicGroup Class Reference

Inheritance diagram for GlsMimicGroup:

Public Member Functions
	GlsMimicGroup ()
	GlsMimicGroup (DisplayObjectArray *objs)
bool	MimicGroupActive (None)
None	MimicGroupActive (bool value)
Vector	BottomLeftCorner (None)
None	BottomLeftCorner (Vector &value)
Vector	TopRightCorner (None)
None	TopRightCorner (Vector &value)
bool	ShowOutline (None)
None	ShowOutline (bool value)
int	TextureWidth ()
None	TextureWidth (int textureWidth)
int	TextureHeight ()
None	TextureHeight (int textureHeight)
int	AttachedTextureIndex ()
None	AttachedTextureIndex (int textureIndex)
bool	GenerateMipMaps ()
None	GenerateMipMaps (bool generate)
bool	DrawMimicGroupPolygon ()
None	DrawMimicGroupPolygon (bool draw)
int	MimicGroupDepthTest ()
None	MimicGroupDepthTest (int depthTestSettings)
bool	HasDepthBuffer ()
None	HasDepthBuffer (bool hasDepthBuffer)
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 GlsMimicGroup *	CastToGlsMimicGroup (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 MimicGroups in GL Studio.

Constructor & Destructor Documentation

GlsMimicGroup() [1/2]

GlsMimicGroup::GlsMimicGroup

(

)

GlsMimicGroup() [2/2]

GlsMimicGroup::GlsMimicGroup

(

DisplayObjectArray *

objs

)

Member Function Documentation

AttachedTextureIndex() [1/2]

int GlsMimicGroup::AttachedTextureIndex

(

)

Accessor for the GL Studio texture index the mimic will generate into.

Returns

the GL Studio texture index to generate mimic into. If -1, then mimic will generate its own texture.

AttachedTextureIndex() [2/2]

None GlsMimicGroup::AttachedTextureIndex

(

int

textureIndex

)

Set the GL Studio texture index the mimic will generate into.

Parameters

textureIndex

the GL Studio texture index to generate mimic into. If -1, then mimic will generate its own texture.

BottomLeftCorner() [1/2]

Vector GlsMimicGroup::BottomLeftCorner

(

None

)

Returns

Gets bottom left corner of clip region

BottomLeftCorner() [2/2]

None GlsMimicGroup::BottomLeftCorner

(

Vector &

value

)

Sets new bottom left corner for the clip region.

Parameters

value

The new bottom left corner coordinate

CastToGlsMimicGroup()

static GlsMimicGroup * GlsMimicGroup::CastToGlsMimicGroup ( DisplayObject *  obj )

static

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

Parameters

obj	objects to cast

Returns

GlsMimicGroup the GlsMimicGroup

Exceptions

CEIException

DrawMimicGroupPolygon() [1/2]

bool GlsMimicGroup::DrawMimicGroupPolygon

(

)

Whether or not an mimic polygon will be drawn.

Returns

true if an mimic polygon will be drawn.

DrawMimicGroupPolygon() [2/2]

None GlsMimicGroup::DrawMimicGroupPolygon

(

bool

draw

)

Set whether or not an mimic polygon will be drawn.

Parameters

draw	true if an mimic polygon will be drawn.

GenerateMipMaps() [1/2]

bool GlsMimicGroup::GenerateMipMaps

(

)

Whether or not the mimic will generate mip maps.

Returns

true if the mimic will generate mip maps.

GenerateMipMaps() [2/2]

None GlsMimicGroup::GenerateMipMaps

(

bool

generate

)

Set whether or not the mimic will generate mip maps.

Parameters

generate

true if the mimic will generate mip maps.

HasDepthBuffer() [1/2]

bool GlsMimicGroup::HasDepthBuffer

(

)

Whether or not the mimic will render a depth buffer.

Returns

true if the mimic will render a depth buffer.

HasDepthBuffer() [2/2]

None GlsMimicGroup::HasDepthBuffer

(

bool

hasDepthBuffer

)

Set whether or not the mimic will render a depth buffer.

Parameters

hasDepthBuffer

true if the mimic will render a depth buffer.

MimicGroupActive() [1/2]

None GlsMimicGroup::MimicGroupActive

(

bool

value

)

Sets if mimic is active for this group.

Parameters

value

The new mimic value

MimicGroupActive() [2/2]

bool GlsMimicGroup::MimicGroupActive

(

None

)

Returns

If mimic is active for this group

MimicGroupDepthTest() [1/2]

int GlsMimicGroup::MimicGroupDepthTest

(

)

Accessor for the mimic depth test settings.

Returns

the depth settings

MimicGroupDepthTest() [2/2]

None GlsMimicGroup::MimicGroupDepthTest

(

int

depthTestSettings

)

Set the mimic depth test settings.

Parameters

depthTestSettings

the depth settings

ShowOutline() [1/2]

None GlsMimicGroup::ShowOutline

(

bool

value

)

Sets if clip region should always be drawn in the editor.

Parameters

value

The new show value

ShowOutline() [2/2]

bool GlsMimicGroup::ShowOutline

(

None

)

Returns

If clip region should always be drawn in the editor

TextureHeight() [1/2]

int GlsMimicGroup::TextureHeight

(

)

Accessor for the mimic texture height.

Returns

the height, in pixels, of the mimic texture.

TextureHeight() [2/2]

None GlsMimicGroup::TextureHeight

(

int

textureHeight

)

Set the mimic texture height.

Parameters

textureHeight

the height, in pixels, of the mimic texture.

TextureWidth() [1/2]

int GlsMimicGroup::TextureWidth

(

)

Accessor for the mimic texture width.

Returns

the witdh, in pixels, of the mimic texture.

TextureWidth() [2/2]

None GlsMimicGroup::TextureWidth

(

int

textureWidth

)

Set the mimic texture width.

Parameters

textureWidth

the witdh, in pixels, of the mimic texture.

TopRightCorner() [1/2]

Vector GlsMimicGroup::TopRightCorner

(

None

)

Returns

Gets top right corner of clip region

TopRightCorner() [2/2]

None GlsMimicGroup::TopRightCorner

(

Vector &

value

)

Sets new top right corner for the clip region.

Parameters

value

The new top right corner coordinate

---

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

• GlsMimicGroup.i