Python Script Engine  7.2
GL Studio Editor Python Script API
Group Class Reference
+ Inheritance diagram for Group:

Public Member Functions

 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)
 
DisplayObjectArrayGetObjectList ()
 
DisplayObjectGetObjectByIndex (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)
 
GlsMatrixAffineGetDcsMatrix ()
 
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< VectorGetTextureCoordinates ()
 
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< VectorGetTexturePoints ()
 
void GetVertices (VertexArray *verts)
 
void SetVertices (VertexArray &verts)
 
String GetInitialization ()
 
void SetInitialization (String initCode)
 
String GetCallbackCode ()
 
void SetCallbackCode (String cbCode)
 
DisplayObjectDuplicateObject (Document *doc=NULL)
 
DisplayObjectTessellateObject ()
 
DisplayObjectExtrudeObject (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 ()
 
String GetUserDefinedAttributeValue (String attribName)
 
 typemap (check) String attribName
 
void SetUserDefinedAttributeValue (String attribName, String value)
 
DisplayObjectGetParent ()
 
DocumentGetDocument ()
 
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< VectorGetNormals ()
 
void SetNormals (std::vector< Vector > &normals)
 
std::vector< CustomAttributeInfoGetExtraAttributes ()
 
DisplayObjectCloneObject ()
 
void CopyProperties (DisplayObject *sourceObj)
 
void SetLocation (Vector loc)
 
GlsMatrixAffine GetObjectCoordinatesTransform (DisplayObject *targetObject)
 
void CalculateParentBoundingBox ()
 
void SetOrigin (Vertex &vert)
 

Static Public Member Functions

static GroupCastToGroup (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::Group ( )

Constructs an empty group.

Group::Group ( DisplayObjectArray objs)

Creates a group with the specified objects.

Parameters
objsThe array of display objects
Note
Reparents the objects if needed.

Member Function Documentation

void 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
void Group::CalculateTextureCoordinates ( void  )

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

Precondition
!isNULL()
Exceptions
CEIException
static Group* Group::CastToGroup ( DisplayObject obj)
static

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

Parameters
objThe display object to cast.
unsigned int Group::Count ( void  )

the number of objects within the group

Precondition
!isNULL()
Exceptions
CEIException
Returns
unsigned int the number of the objects within the group
unsigned int Group::GetCount ( )

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

Since
GL Studio 6.2.1
DisplayObject* Group::GetObjectByIndex ( unsigned int  index)

Returns an item based on index.

Precondition
!isNULL()
Parameters
indexthe index of the item to be returned (zero-based indexing)
Returns
DisplayObject the item at the given index
Exceptions
CEIException
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
void 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
objobject to be added
reparentreparent the object after it is added, default True
recalculateBoundingboxrecalculate the bounding box of the group after the object is added, default True
locLocation of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list
renameNameAllows 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
void 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
objobject to be added
reparentreparent the object after it is added, default True
recalculateBoundingboxrecalculate the bounding box of the group after the object is added, default True
locLocation of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list
void 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
objobject to be moved
recalculateBoundingboxrecalculate the bounding box of the groups after the object is moved, default True
locLocation of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list
renameNameAllows 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
void 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
objobject to be moved
recalculateBoundingboxrecalculate the bounding box of the groups after the object is moved, default True
locLocation of the object within the group, default DEFAULT_GROUP_LOCATION - the end of the list
void Group::ReorderObject ( unsigned int  oldIndex,
unsigned int  newIndex 
)

Reorders the object from oldIndex to newIndex.

Precondition
!isNULL()
Exceptions
CEIException
Parameters
oldIndexthe old index of the object
newIndexthe index the object will be moved to
void 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
vGiven vertex
Since
GL Studio 6.3.1
void Group::Ungroup ( )

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

Member Data Documentation

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: