Python Script Engine  8.3
GL Studio Editor Python Script API
Public Member Functions | Static Public Member Functions | List of all members
GlsDynamicPath Class Reference
+ Inheritance diagram for GlsDynamicPath:

Public Member Functions

 GlsDynamicPath ()
 
bool AffectsLocationX ()
 
None AffectsLocationX (bool affects)
 
bool AffectsLocationY ()
 
None AffectsLocationY (bool affects)
 
bool AffectsLocationZ ()
 
None AffectsLocationZ (bool affects)
 
bool AffectsRotationX ()
 
None AffectsRotationX (bool affects)
 
bool AffectsRotationY ()
 
None AffectsRotationY (bool affects)
 
bool AffectsRotationZ ()
 
None AffectsRotationZ (bool affects)
 
bool UseShortRotationPaths ()
 
None UseShortRotationPaths (bool affects)
 
bool AffectsScaleX ()
 
None AffectsScaleX (bool affects)
 
bool AffectsScaleY ()
 
None AffectsScaleY (bool affects)
 
bool AffectsScaleZ ()
 
None AffectsScaleZ (bool affects)
 
GlsDynamicPathState GetState (int index)
 
None AddState (GlsDynamicPathState &inputState)
 
None SetState (int index, GlsDynamicPathState &inputState)
 
None RemoveState (int index)
 
- 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 GlsDynamicPath * CastToGlsDynamicPath (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 DisplayObject
static int TEXTURE_INDEX_NONE = -1
 

Detailed Description

Python extension used to modify and create GlsDynamicPath editor objects.

Constructor & Destructor Documentation

◆ GlsDynamicPath()

GlsDynamicPath::GlsDynamicPath ( )

Constructor.

Creates a new GlsDynamicPath.

Member Function Documentation

◆ AddState()

None GlsDynamicPath::AddState ( GlsDynamicPathState &  inputState)

Adds a new dynamic path state at the end of the state list.

Parameters
inputStatestate to add

◆ AffectsLocationX() [1/2]

bool GlsDynamicPath::AffectsLocationX ( )

Determines whether the dynamic path affects the X location.

Returns
true if the dynamic path affects the X location, false otherwise

◆ AffectsLocationX() [2/2]

None GlsDynamicPath::AffectsLocationX ( bool  affects)

Sets whether the dynamic path affects the X location.

Parameters
affectstrue if the dynamic path affects the X location, false otherwise

◆ AffectsLocationY() [1/2]

bool GlsDynamicPath::AffectsLocationY ( )

Determines whether the dynamic path affects the Y location.

Returns
true if the dynamic path affects the Y location, false otherwise

◆ AffectsLocationY() [2/2]

None GlsDynamicPath::AffectsLocationY ( bool  affects)

Sets whether the dynamic path affects the Y location.

Parameters
affectstrue if the dynamic path affects the Y location, false otherwise

◆ AffectsLocationZ() [1/2]

bool GlsDynamicPath::AffectsLocationZ ( )

Determine whether the dynamic path affects the Z location.

Returns
true if the dynamic path affects the Z location, false otherwise

◆ AffectsLocationZ() [2/2]

None GlsDynamicPath::AffectsLocationZ ( bool  affects)

Sets whether the dynamic path affects the Z location.

Parameters
affectstrue if the dynamic path affects the Z location, false otherwise

◆ AffectsRotationX() [1/2]

bool GlsDynamicPath::AffectsRotationX ( )

Determine whether the dynamic path affects the X rotation.

Returns
true if the dynamic path affects the X rotation, false otherwise

◆ AffectsRotationX() [2/2]

None GlsDynamicPath::AffectsRotationX ( bool  affects)

Sets whether the dynamic path affects the X rotation.

Parameters
affectstrue if the dynamic path affects the X rotation, false otherwise

◆ AffectsRotationY() [1/2]

bool GlsDynamicPath::AffectsRotationY ( )

Determine whether the dynamic path affects the Y rotation.

Returns
true if the dynamic path affects the Y rotation, false otherwise

◆ AffectsRotationY() [2/2]

None GlsDynamicPath::AffectsRotationY ( bool  affects)

Sets whether the dynamic path affects the Y rotation.

Parameters
affectstrue if the dynamic path affects the Y rotation, false otherwise

◆ AffectsRotationZ() [1/2]

bool GlsDynamicPath::AffectsRotationZ ( )

Determine whether the dynamic path affects the Z rotation.

Returns
true if the dynamic path affects the Z rotation, false otherwise

◆ AffectsRotationZ() [2/2]

None GlsDynamicPath::AffectsRotationZ ( bool  affects)

Sets whether the dynamic path affects the Z rotation.

Parameters
affectstrue if the dynamic path affects the Z rotation, false otherwise

◆ AffectsScaleX() [1/2]

bool GlsDynamicPath::AffectsScaleX ( )

Determine whether the dynamic path affects the X scale.

Returns
true if the dynamic path affects the X scale, false otherwise

◆ AffectsScaleX() [2/2]

None GlsDynamicPath::AffectsScaleX ( bool  affects)

Sets whether the dynamic path affects the X scale.

Parameters
affectstrue if the dynamic path affects the X scale, false otherwise

◆ AffectsScaleY() [1/2]

bool GlsDynamicPath::AffectsScaleY ( )

Determine whether the dynamic path affects the Y scale.

Returns
true if the dynamic path affects the Y scale, false otherwise

◆ AffectsScaleY() [2/2]

None GlsDynamicPath::AffectsScaleY ( bool  affects)

Sets whether the dynamic path affects the Y scale.

Parameters
affectstrue if the dynamic path affects the Y scale, false otherwise

◆ AffectsScaleZ() [1/2]

bool GlsDynamicPath::AffectsScaleZ ( )

Determine whether the dynamic path affects the Z scale.

Returns
true if the dynamic path affects the Z scale, false otherwise

◆ AffectsScaleZ() [2/2]

None GlsDynamicPath::AffectsScaleZ ( bool  affects)

Sets whether the dynamic path affects the Z scale.

Parameters
affectstrue if the dynamic path affects the Z scale, false otherwise

◆ CastToGlsDynamicPath()

static GlsDynamicPath * GlsDynamicPath::CastToGlsDynamicPath ( DisplayObject *  obj)
static

Casts a display object to a dynamic path.

Parameters
objThe display object to cast.

◆ GetState()

GlsDynamicPathState GlsDynamicPath::GetState ( int  index)

Gets the dynamic path state at the specified index.

Parameters
indexindex of the state to retrieve
Returns
the dynamic path state

◆ RemoveState()

None GlsDynamicPath::RemoveState ( int  index)

Removes the state at the specified index.

Parameters
indexindex of the state to be removed

◆ SetState()

None GlsDynamicPath::SetState ( int  index,
GlsDynamicPathState &  inputState 
)

Sets the state at the specified index to the specified state.

Parameters
indexindex of the state to be set
inputStatestate to be set

◆ UseShortRotationPaths() [1/2]

bool GlsDynamicPath::UseShortRotationPaths ( )

Determine whether the shortest path between rotations will be used.

Returns
true if the shortest rotation path will be used, false if the longest path will be used

◆ UseShortRotationPaths() [2/2]

None GlsDynamicPath::UseShortRotationPaths ( bool  affects)

Sets whether the shortest path between rotations will be used.

Parameters
affectstrue if the shortest rotation path will be used, false if the longest path will be used
The documentation for this class was generated from the following file: