Python Script Engine
7.2
GL Studio Editor Python Script API
|
Static Public Attributes | |
static int | TEXTURE_INDEX_NONE = -1 |
Python extension for the DisplayObject Base Class.
This is the base class for all graphical objects. It is an abstract class. Each object drawn in the editor will have a corresponding object. All drawn objects are derived from this class.
Enumeration for Alpha Blending/Testing mode.
Line Style enumeration.
Passed into Line Style calls
String DisplayObject::AlternateClassName | ( | ) |
Gets the alternate class name generated for object.
void DisplayObject::AlternateClassName | ( | String | name | ) |
Sets the alternate class name generated for object.
void DisplayObject::CalculateParentBoundingBox | ( | ) |
Calculates the bounding box of the parent group object.
DisplayObject* DisplayObject::CloneObject | ( | ) |
Returns a clone of the DisplayObject.
void DisplayObject::CopyProperties | ( | DisplayObject * | sourceObj | ) |
Copies properties from the source object to this object.
sourceObj | The object to copy properties from |
DisplayObject* DisplayObject::DuplicateObject | ( | Document * | doc = NULL | ) |
Duplicates the display object.
doc | Document to perform the action in, default NULL will use the parent of the object |
DisplayObject* DisplayObject::ExtrudeObject | ( | float | amount | ) |
Extrudes the object.
amount | Amount to extrude the object |
GlsColor DisplayObject::FillColor | ( | ) |
Gets the fill color of the Display Object.
void DisplayObject::FillColor | ( | GlsColor | color | ) |
Sets the fill color of the Display Object.
color | fill color to be applied to the Display Object |
bool DisplayObject::GetAffectZBufferFlag | ( | ) |
Retrieves the display object's Affect Z-Buffer flag.
int DisplayObject::GetAlphaMode | ( | ) |
Get the alpha mode for this object.
String DisplayObject::GetAlternateClassHeaderFile | ( | ) |
Gets the alternate class header file for object.
bool DisplayObject::GetAntiAliasing | ( | ) |
Retrieves the display object's Anti-Aliasing flag.
String DisplayObject::GetAttributeValueString | ( | String | attribName | ) |
Gets the value for a single attribute of the object.
disti::GlsColor DisplayObject::GetBlendingColor | ( | ) |
Retrieves the display object's Blending Color.
bool DisplayObject::GetBlinking | ( | ) |
Retrieves the display object's blinking flag.
float DisplayObject::GetBlinkRate | ( | ) |
Retrieves the display object's blink rate.
String DisplayObject::GetCallbackCode | ( | ) |
Retrieves the display object's callback code.
PolygonClose_e DisplayObject::GetClosePolygonFlag | ( | ) |
Retrieves the display object's Close Polygon flag.
bool DisplayObject::GetCullBackFaces | ( | ) |
Retrieves the display object's Cull Backfaces flag.
GlsMatrixAffine* DisplayObject::GetDcsMatrix | ( | ) |
Retrieves the display object's DCS matrix.
Document* DisplayObject::GetDocument | ( | ) |
Retrieves the display object's document.
Figure out the static extents for the object.
min | Gets the minimum extents |
max | Gets the maximum extents |
std::vector< CustomAttributeInfo > DisplayObject::GetExtraAttributes | ( | ) |
Gets the properties added by Alternate Class Headers, Catalyzers, and Components.
Intended to support only Python-based code generation.
bool DisplayObject::GetGenerateMemberVariable | ( | ) |
String DisplayObject::GetInitialization | ( | ) |
Retrieves the display object's initialization code.
bool DisplayObject::GetLightingEnabledFlag | ( | ) |
Retrieves the display object's Lighting Enabled flag.
Vertex DisplayObject::GetLocation | ( | ) |
Retrieves the display object's location.
bool DisplayObject::GetLocked | ( | void | ) |
Get the locked status for this object.
int DisplayObject::GetMaterialIndex | ( | ) |
String DisplayObject::GetName | ( | ) |
Retrieves the display object's name.
std::vector< Vector > DisplayObject::GetNormals | ( | ) |
Returns a list of Vector normals for the DisplayObject.
String DisplayObject::GetObjectClassName | ( | ) |
Retrieves the display object's ObjectClassName.
GlsMatrixAffine DisplayObject::GetObjectCoordinatesTransform | ( | DisplayObject * | targetObject | ) |
Gets the transform matrix necessary to convert points from the targetObject to that of this object's coordinate space.
targetObject | the target object |
DisplayObject* DisplayObject::GetParent | ( | ) |
Retrieves the display object's parent.
DisplayObject::PickableType_e DisplayObject::GetPickMode | ( | ) |
Retrieves the display object's pick mode.
PolygonMode_e DisplayObject::GetPolygonMode | ( | ) |
Retrieves the display object's PolygonMode.
DisplayObject::MemberAccess_e DisplayObject::GetProtectionMode | ( | void | ) |
Get the protection mode for this object.
String DisplayObject::GetResources | ( | ) |
Gets all of the resources (AKA, attributes) at the object tree rooted at this object.
Vertex DisplayObject::GetRotationPoint | ( | ) |
Retrieves the display object's rotation point.
String DisplayObject::GetRuntimeResources | ( | bool | recursive | ) |
Gets all of the resources (AKA, attributes) at the object tree rooted at this object.
Only Gets resources that are available at runtime.
recursive | whether or not to recurse to children |
ShadingType_e DisplayObject::GetShadingMode | ( | ) |
Retrieves the display object's Shading Mode.
std::vector< Vector > DisplayObject::GetTextureCoordinates | ( | ) |
Retrieves the display object's Texture Coordinates.
void DisplayObject::GetTextureCoordinates | ( | VertexArray * | texVerts | ) |
Retrieves the display object's Texture Coordinates.
texVerts | returns the object's Texture Coordinates |
int DisplayObject::GetTextureIndex | ( | ) |
Retrieves the display object's Texture Index.
DisplayObject::TextureFilter_e DisplayObject::GetTextureMagnificationFilter | ( | ) |
Retrieves the display object's Texture Magnification Filter.
TextureMap_e DisplayObject::GetTextureMappingTechnique | ( | ) |
Retrieves the display object's Texture Mapping Technique.
DisplayObject::TextureFilter_e DisplayObject::GetTextureMinificationFilter | ( | ) |
Retrieves the display object's Texture Minification Filter.
void DisplayObject::GetTexturePoints | ( | VertexArray * | texVerts | ) |
Retrieves the display object's Texture Points.
texVerts | returns the object's Texture Points |
std::vector<Vector> DisplayObject::GetTexturePoints | ( | ) |
Retrieves the display object's Texture Points.
bool DisplayObject::GetTextureRepeat | ( | ) |
Retrieves the display object's Texture Repeat.
std::map<String , String > DisplayObject::GetUserDefinedAttributes | ( | ) |
Gets a read-only dict of all user defined attributes for the Display Object.
String DisplayObject::GetUserDefinedAttributeValue | ( | String | attribName | ) |
Gets the value of the user defined attribute for the Display Object.
attribName | name of the attribute for which to find the value |
attribName
void DisplayObject::GetVertices | ( | VertexArray * | verts | ) |
Retrieves the display object's Vertices.
verts | returns the object's Vertices |
bool DisplayObject::GetVisibilityFlag | ( | ) |
Retrieves the display object's Visibility flag.
bool DisplayObject::GetZBufferTestedFlag | ( | ) |
Retrieves the display object's Z-Buffer Tested flag.
bool DisplayObject::HasUserDefinedAttribute | ( | String | attribName | ) |
Checks the value of the user defined attribute for the Display Object.
attribName | name of the attribute for which to find the value |
bool DisplayObject::isNULL | ( | void | ) |
Determine if wrapped display object does not exist.
GlsColor DisplayObject::LineColor | ( | ) |
Gets the line color of the Display Object.
void DisplayObject::LineColor | ( | GlsColor | color | ) |
Sets the line color of the Display Object.
color | line color to be applied to the Display Object |
LineStyle_e DisplayObject::LineStyle | ( | ) |
Gets the line style of the Display Object.
void DisplayObject::LineStyle | ( | LineStyle_e | style | ) |
Sets the line style of the Display Object.
style | line style to be applied to the Display Object |
void DisplayObject::LineWidth | ( | float | width | ) |
Sets the line width of the Display Object.
width | line width to be applied to the Display Object |
float DisplayObject::LineWidth | ( | ) |
Gets the line width of the Display Object.
unsigned int DisplayObject::RegisterObserver | ( | String | attribName, |
PyObject * | pyfunc | ||
) |
Register a python function to be called when the specified attribute changes value.
This function does not take ownership of the python function, so it must persist in order to be called. When the python function goes away, it will be automatically unregistered.
attribName | the name of the attribute to register with |
pyfunc | the python function to call when the attribute is changed is changed. It takes a single paramater, which is the string value of the attribute, as would be normally returned with a call to GetAttributeValueString |
void DisplayObject::RotateObject | ( | float | amount, |
RotationAxis_e | axis | ||
) |
Rotate the object.
amount | amount to rotate the object |
axis | axis of rotation |
void DisplayObject::ScaleObject | ( | float | x, |
float | y, | ||
float | z, | ||
Vertex * | anchor = NULL |
||
) |
Scale the object.
x | Value of the percentage of scale in x-axis |
y | Value of the percentage of scale in y-axis |
z | Value of the percentage of scale in z-axis |
anchor | Anchor from which to scale object relative to, default NULL will anchor at object location |
void DisplayObject::SetAffectZBufferFlag | ( | bool | affect | ) |
Sets the display object's Affect Z-Buffer flag.
affect | New state for the Affect Z-Buffer flag of the object |
void DisplayObject::SetAlphaMode | ( | int | mode | ) |
Set the alpha mode state for this object.
mode | which alpha mode to use when drawing |
void DisplayObject::SetAlternateClassHeaderFile | ( | String | name | ) |
Sets the alternate class header file for object.
void DisplayObject::SetAntiAliasing | ( | bool | antiAliasing | ) |
Sets the display object's name.
antiAliasing | New state for the anti-aliasing flag of the object |
void DisplayObject::SetAttributeValueString | ( | String | attribName, |
String | value | ||
) |
Sets the value for a single attribute of the object.
void DisplayObject::SetBlendingColor | ( | GlsColor | blendColor | ) |
Sets the display object's Blending Color.
blendColor | New Blending Color of the object |
void DisplayObject::SetBlinking | ( | bool | blinking | ) |
Sets the display object's blinking flag.
blinking | New state for the blinking flag of the object |
void DisplayObject::SetBlinkRate | ( | float | rate | ) |
Sets the display object's blinking rate.
rate | New rate for the blink of the object |
void DisplayObject::SetCallbackCode | ( | String | cbCode | ) |
Sets the display object's callback code.
cbCode | New callback code for the object |
void DisplayObject::SetClosePolygonFlag | ( | PolygonClose_e | closePolygon | ) |
Sets the display object's Close Polygon flag.
closePolygon | New state for the Close Polygon flag of the object |
void DisplayObject::SetCullBackFaces | ( | bool | cullFaces | ) |
Sets the display object's Cull Backfaces flag.
cullFaces | New state for the Cull Backfaces flag of the object |
void DisplayObject::SetDcsMatrix | ( | GlsMatrixAffine * | matrix | ) |
Sets the display object's DCS matrix.
matrix | New DCS matrix to apply to the object |
void DisplayObject::SetGenerateMemberVariable | ( | bool | b | ) |
void DisplayObject::SetInitialization | ( | String | initCode | ) |
Sets the display object's initialization code.
initCode | New initialization code for the object |
void DisplayObject::SetLightingEnabledFlag | ( | bool | enabled | ) |
Sets the display object's Lighting Enabled flag.
enabled | New state for the Lighting Enabled flag of the object |
void DisplayObject::SetLocation | ( | Vertex | loc | ) |
Sets the display object's location.
loc | New location of the object |
void DisplayObject::SetLocation | ( | Vector | loc | ) |
Sets the display object's location.
loc | New location of the object |
void DisplayObject::SetLocked | ( | bool | val | ) |
Set the locked status for this object.
val | Set locked status. |
void DisplayObject::SetMaterialIndex | ( | int | matIndex | ) |
String DisplayObject::SetName | ( | String | name | ) |
Sets the display object's name.
If name
is not a valid C++ identifier, it will attempt to make it one. If it is unable to set it after fixing, it will throw an exception. If an object with the same name already exists, will throw an exception.
name | New name of object |
name
was not a valid C++ identifier, the returned name will be a valid identifier. RuntimeError | If name is empty |
RuntimeError | If name cannot be made into a valid C++ identifier |
void DisplayObject::SetNormals | ( | std::vector< Vector > & | normals | ) |
Sets the normal vectors for the DisplayObject.
normals | the list of new normal Vectors for the object |
void DisplayObject::SetOrigin | ( | Vertex & | vert | ) |
Redefines the frame of reference for the object.
Since the vertices in the object are specified relative to the _location member, this routine allows you to specify the absolute coordinate for _location and then recalculates the vertices to be relative to that new location
vert | The new origin point for the object |
void DisplayObject::SetPickMode | ( | DisplayObject::PickableType_e | mode | ) |
Sets the display object's pick mode.
mode | New mode for object's pick mode |
void DisplayObject::SetPolygonMode | ( | PolygonMode_e | polygonMode | ) |
Sets the display object's PolygonMode.
polygonMode | New state for the PolygonMode of the object |
void DisplayObject::SetProtectionMode | ( | DisplayObject::MemberAccess_e | mode | ) |
Set the protection mode for this object.
i.e., will the object be generated as a pubic, private, or protected member variable?
mode | How the variable will be generated: PUBLIC, PRIVATE, PROTECTED |
void DisplayObject::SetRotationPoint | ( | Vertex | rotPoint | ) |
Sets the display object's rotation point.
rotPoint | New location of the object's rotation point |
void DisplayObject::SetShadingMode | ( | ShadingType_e | shadingMode | ) |
Sets the display object's Shading Mode.
shadingMode | New Shading Mode of the object |
void DisplayObject::SetTextureCoordinates | ( | std::vector< Vector > & | texVerts | ) |
Sets the display object's Texture Coordinates.
texVerts | New Texture Coordinates of the object |
void DisplayObject::SetTextureCoordinates | ( | VertexArray & | texVerts | ) |
Sets the display object's Texture Coordinates.
texVerts | New Texture Coordinates of the object |
void DisplayObject::SetTextureIndex | ( | int | texIndex | ) |
Sets the display object's Texture Index.
texIndex | New Texture Index of the object |
void DisplayObject::SetTextureMagnificationFilter | ( | DisplayObject::TextureFilter_e | filter | ) |
Sets the display object's Texture Magnification Filter.
filter | New Texture Magnification Filter of the object; either TEXTURE_FILTER_NEAREST or TEXTURE_FILTER_LINEAR |
void DisplayObject::SetTextureMappingTechnique | ( | TextureMap_e | mappingTechnique | ) |
Sets the display object's Texture Mapping Technique.
mappingTechnique | New Texture Mapping Technique of the object |
void DisplayObject::SetTextureMinificationFilter | ( | DisplayObject::TextureFilter_e | filter | ) |
Sets the display object's Texture Minification Filter.
filter | New Texture Minification Filter of the object |
void DisplayObject::SetTexturePoints | ( | VertexArray & | texVerts | ) |
Sets the display object's Texture Points.
texVerts | New Texture Points of the object |
void DisplayObject::SetTexturePoints | ( | std::vector< Vector > & | texVerts | ) |
Sets the display object's Texture Points.
texVerts | New Texture Points of the object |
void DisplayObject::SetTextureRepeat | ( | bool | repeat | ) |
Sets the display object's Texture Repeat.
repeat | New Texture Repeat of the object |
void DisplayObject::SetUserDefinedAttributeValue | ( | String | attribName, |
String | value | ||
) |
Sets the value of the user defined attribute for the Display Object.
attribName | name of the attribute for which to set the value |
value | value to be given to the attribute |
void DisplayObject::SetVertices | ( | VertexArray & | verts | ) |
Sets the display object's Vertices.
verts | New vertex list for the object, with at least two vertices |
void DisplayObject::SetVisibilityFlag | ( | bool | visible | ) |
Sets the display object's Visibility flag.
visible | New state for the Visibility flag of the object |
void DisplayObject::SetZBufferTestedFlag | ( | bool | tested | ) |
Sets the display object's Z-Buffer Tested flag.
tested | New state for the Z-Buffer Tested flag of the object |
DisplayObject* DisplayObject::TessellateObject | ( | ) |
Tessellates the object.
void DisplayObject::TranslateObject | ( | float | x, |
float | y, | ||
float | z | ||
) |
Translate the object.
x | translation amount along the x-axis |
y | translation amount along the y-axis |
z | translation amount along the z-axis |
DisplayObject::typemap | ( | check | ) |
void DisplayObject::UnregisterObserver | ( | String | attribName, |
unsigned int | id | ||
) |
Unregister a previously registered observer.
attribName | the name of the attribute to unregister with |
id | the id that was returned from the call to RegisterObserver |
|
static |