Python Script Engine  8.3
GL Studio Editor Python Script API
ComponentRef Class Reference
+ Inheritance diagram for ComponentRef:

Public Member Functions

 ComponentRef ()
 
 ComponentRef (Group *srcObjs, str tmpFilePath)
 
bool isNULL ()
 
None ReloadComponentFile ()
 
None SetComponentFilePath (str filename)
 
str GetComponentFilePath ()
 
RSOAvailableAttributesArray GetAvailableAttributes ()
 
RSOInitialAttributeValuesArray GetInitialAttributeValues ()
 
None SetInitialAttributeValue (str attribute, str attributeValue)
 
None DeleteInitialAttributeValue (str attribute)
 
bool UsingLiveComponent () throw ( CEIException& )
 
- 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)
 
DisplayObjectArrayGetObjectList ()
 
DisplayObjectGetObjectByIndex (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)
 
GlsMatrixAffineGetDcsMatrix ()
 
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)
 
DisplayObjectDuplicateObject (Document *doc=NULL)
 
DisplayObjectTessellateObject ()
 
DisplayObjectExtrudeObject (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)
 
DisplayObjectGetParent ()
 
DocumentGetDocument ()
 
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 ()
 
DisplayObjectCloneObject ()
 
None CopyProperties (DisplayObject *sourceObj)
 
None SetLocation (Vector loc)
 
GlsMatrixAffine GetObjectCoordinatesTransform (DisplayObject *targetObject)
 
None CalculateParentBoundingBox ()
 
None SetOrigin (Vertex &vert)
 

Static Public Member Functions

static ComponentRefCastToComponentRef (DisplayObject *obj)
 
- Static Public Member Functions inherited from Group
static GroupCastToGroup (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 to access and modify Component reference settings.

Constructor & Destructor Documentation

◆ ComponentRef() [1/2]

ComponentRef::ComponentRef ( )

◆ ComponentRef() [2/2]

ComponentRef::ComponentRef ( Group srcObjs,
str  tmpFilePath 
)

Member Function Documentation

◆ CastToComponentRef()

static ComponentRef * ComponentRef::CastToComponentRef ( DisplayObject obj)
static

◆ DeleteInitialAttributeValue()

None ComponentRef::DeleteInitialAttributeValue ( str  attribute)

delete an initial RSO attribute value

Parameters
attributeattribute in question
Precondition
!isNULL(), GetAvailableAttributes().IsAttributeInArray( attribute ) == true

◆ GetAvailableAttributes()

RSOAvailableAttributesArray ComponentRef::GetAvailableAttributes ( )

get an array of the available RSO attribute names

Returns
an array of the available RSO attribute names
Precondition
!iSNULL()

◆ GetComponentFilePath()

str ComponentRef::GetComponentFilePath ( )

Gets the path to the component file (.gls or .dll/.so) for this component object.

See also
SetComponentFilePath()

◆ GetInitialAttributeValues()

RSOInitialAttributeValuesArray ComponentRef::GetInitialAttributeValues ( )

get an array of the initial RSO attribute values

Returns
an array of the initial RSO attribute values
Precondition
!isNULL()

◆ isNULL()

bool ComponentRef::isNULL ( )

determine if wrapped componet ref does not exist

Returns
true if wrapped component ref does not exist
Deprecated:
Refer to the Truth Value Checking page

◆ ReloadComponentFile()

None ComponentRef::ReloadComponentFile ( )

Forces a reload of a Component File.

Precondition
!isNULL()

◆ SetComponentFilePath()

None ComponentRef::SetComponentFilePath ( str  filename)

Sets the path to the component file (.gls or .dll/.so) for this component object.

See also
GetComponentFilePath()

◆ SetInitialAttributeValue()

None ComponentRef::SetInitialAttributeValue ( str  attribute,
str  attributeValue 
)

set an initial RSO attribute value

Parameters
attributeattribute in question
attributeValueinitial value for attribute
Precondition
!isNULL(), GetAvailableAttributes().IsAttributeInArray( attribute ) == true

◆ UsingLiveComponent()

bool ComponentRef::UsingLiveComponent ( )
throw (CEIException &
)

Returns whether the component is a live (pre-built) or a design file.


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