Inheritance diagram for Group:

Public Member Functions
	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 Group *	CastToGroup (DisplayObject *obj)

Static Public Attributes
static int	DEFAULT_GROUP_LOCATION = -1

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

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 }

Detailed Description

Python Script Editor interface for Group editor objects.

Constructor & Destructor Documentation

◆ Group() [1/2]

Group::Group ( )

Constructs an empty group.

◆ Group() [2/2]

Group::Group ( DisplayObjectArray * objs )

Creates a group with the specified objects.

Parameters

objs	The array of display objects

Note: Reparents the objects if needed.

Member Function Documentation

◆ CalculateBoundingBox()

None Group::CalculateBoundingBox ( )

Calculates the vertices to form the bounding box containing all child objects.

Note: Needed if any child object's extents or location is changed by the user.

Since: GL Studio 6.3.1

◆ CalculateTextureCoordinates()

None Group::CalculateTextureCoordinates ( None )

Recalculates the texture coordinates for the object based on the TexturePoints.

Precondition: !isNULL()

Exceptions

CEIException

◆ CastToGroup()

static Group * Group::CastToGroup ( DisplayObject * obj )

static

Casts a DisplayObject to a Group (returns null on failure to cast)

Parameters

obj	The display object to cast.

◆ Count()

int Group::Count ( )

the number of objects within the group

Precondition: !isNULL()

Exceptions

CEIException

Returns: int the number of the objects within the group

◆ GetCount()

int Group::GetCount ( )

Alias of Group::Count() for consistency with the rest of the Python API.

Since: GL Studio 6.2.1

◆ GetObjectByIndex()

DisplayObject * Group::GetObjectByIndex ( int index )

Returns an item based on index.

Precondition: !isNULL()

Parameters

index the index of the item to be returned (zero-based indexing)

Returns: DisplayObject the item at the given index

Exceptions

CEIException

◆ GetObjectList()

DisplayObjectArray * Group::GetObjectList ( )

Returns a list of the objects in order.

Precondition: !isNULL()

Returns: DisplayObjectArray the array containing the objects of the group

Exceptions

CEIException

◆ InsertObject()

None Group::InsertObject	(	DisplayObject *	obj,
		bool	reparent = `true`,
		bool	recalculateBoundingbox = `true`,
		int	loc = `DEFAULT_GROUP_LOCATION`,
		bool	renameName = `false`
	)

Inserts an object into the group.

Precondition: !isNULL()

Exceptions

CEIException

Parameters

obj	object to be added
reparent	reparent the object after it is added, default True
recalculateBoundingbox	recalculate the bounding box of the group after the object is added, default True
loc	Location of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list
renameName	Allows the object name to be altered if a duplicate name is found, otherwise the function throws an exception if a duplicate name is found, default False

◆ InsertObjectAllowDuplicateNames()

None Group::InsertObjectAllowDuplicateNames	(	DisplayObject *	obj,
		bool	reparent = `true`,
		bool	recalculateBoundingbox = `true`,
		int	loc = `DEFAULT_GROUP_LOCATION`
	)

Inserts an object into the group.

Does not rename object or throw if the object name is a duplicate. Should only be used in cases where the object name will be made unique later (e.g. in a catalyzer)

Precondition: !isNULL()

Exceptions

CEIException

Parameters

obj	object to be added
reparent	reparent the object after it is added, default True
recalculateBoundingbox	recalculate the bounding box of the group after the object is added, default True
loc	Location of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list

◆ MoveObjectToGroup()

None Group::MoveObjectToGroup	(	DisplayObject *	obj,
		bool	recalculateBoundingbox = `true`,
		int	loc = `DEFAULT_GROUP_LOCATION`,
		bool	renameName = `false`
	)

Moves an object from its current group into this group.

Precondition: !isNULL()

Exceptions

CEIException

Parameters

obj	object to be moved
recalculateBoundingbox	recalculate the bounding box of the groups after the object is moved, default True
loc	Location of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list
renameName	Allows the object name to be altered if a duplicate name is found, otherwise the function throws an exception if a duplicate name is found, default False

◆ MoveObjectToGroupAllowDuplicateNames()

None Group::MoveObjectToGroupAllowDuplicateNames	(	DisplayObject *	obj,
		bool	recalculateBoundingbox = `true`,
		int	loc = `DEFAULT_GROUP_LOCATION`
	)

Moves an object from its current group into this group.

Does not rename object or throw if the object name is a duplicate. Should only be used in cases where the object name will be made unique later (e.g. in a catalyzer)

Precondition: !isNULL()

Exceptions

CEIException

Parameters

obj	object to be moved
recalculateBoundingbox	recalculate the bounding box of the groups after the object is moved, default True
loc	Location of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list

◆ ReorderObject()

None Group::ReorderObject	(	int	oldIndex,
		int	newIndex
	)

Reorders the object from oldIndex to newIndex.

Precondition: !isNULL()

Exceptions

CEIException

Parameters

oldIndex	the old index of the object
newIndex	the index the object will be moved to

◆ SetGroupLocation()

None Group::SetGroupLocation ( Vertex & v )

Copies the given vertex data into the group's location vertex thereby moving the group's location member without affecting its child objects.

Parameters

v	Given vertex

Since: GL Studio 6.3.1

◆ Ungroup()

None Group::Ungroup ( )

Destroys a group, and places all of the contained objects into the group's parent group.

Member Data Documentation

◆ DEFAULT_GROUP_LOCATION

int Group::DEFAULT_GROUP_LOCATION = -1

static

Default group location.

This specifies the end of the list.

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

Group.i

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Group() [1/2]

◆ Group() [2/2]

Member Function Documentation

◆ CalculateBoundingBox()

◆ CalculateTextureCoordinates()

◆ CastToGroup()

◆ Count()

◆ GetCount()

◆ GetObjectByIndex()

◆ GetObjectList()

◆ InsertObject()

◆ InsertObjectAllowDuplicateNames()

◆ MoveObjectToGroup()

◆ MoveObjectToGroupAllowDuplicateNames()

◆ ReorderObject()

◆ SetGroupLocation()

◆ Ungroup()

Member Data Documentation

◆ DEFAULT_GROUP_LOCATION