GlsClippingGroup Class Reference

Inheritance diagram for GlsClippingGroup:

Public Member Functions
	GlsClippingGroup ()
	GlsClippingGroup (DisplayObjectArray *objs)
bool	ClippingActive (void)
void	ClippingActive (bool value)
Vector	Blc (void)
void	Blc (Vector &value)
Vector	Trc (void)
void	Trc (Vector &value)
bool	ShowOutline (void)
void	ShowOutline (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 GlsClippingGroup *	CastToGlsClippingGroup (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

Python extension used to create and modify GlsClippingGroup editor objects.

Constructor & Destructor Documentation

GlsClippingGroup::GlsClippingGroup

(

)

GlsClippingGroup::GlsClippingGroup

(

DisplayObjectArray *

objs

)

Member Function Documentation

Vector GlsClippingGroup::Blc

(

void

)

Returns

Gets bottom left corner of clip region

void GlsClippingGroup::Blc

(

Vector &

value

)

Sets new bottom left corner for the clip region.

Parameters

value

The new blc

static GlsClippingGroup* GlsClippingGroup::CastToGlsClippingGroup ( DisplayObject *  obj )

static

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

Parameters

obj	objects to cast

Returns

GlsClippingGroup the GlsClippingGroup

Exceptions

CEIException

bool GlsClippingGroup::ClippingActive

(

void

)

Returns

If clipping is active for this group

void GlsClippingGroup::ClippingActive

(

bool

value

)

Sets if clipping is active for this group.

Parameters

value

The new clipping value

bool GlsClippingGroup::ShowOutline

(

void

)

Returns

If clip region should always be drawn in the editor

void GlsClippingGroup::ShowOutline

(

bool

value

)

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

Parameters

value

The new show value

Vector GlsClippingGroup::Trc

(

void

)

Returns

Gets top right corner of clip region

void GlsClippingGroup::Trc

(

Vector &

value

)

Sets new top right corner for the clip region.

Parameters

value

The new trc

---

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

• GlsClippingGroup.i