![]() |
Python Script Engine
8.3
GL Studio Editor Python Script API
|
Module Methods | |
Methods that can be called on the module. | |
Document | GetCurrentDocument () |
Document | GetDocumentByName (str docName) |
Document | NewDocument (str fileName="") |
None | SaveAllDocuments () |
None | CloseAllDocuments () |
Document | OpenDocument (str fileName, bool showTab=true) |
common editor interface document
enum Document::RedrawMode |
int Document::AddNewMaterial | ( | Material & | newMaterial | ) |
Adds a given material to a given document.
newMaterial | Material to be added to the document |
CEIException |
int Document::AddNewMethod | ( | Method & | newMethod | ) |
Adds a given method to a given document.
newMethod | Method to be added to the document |
CEIException |
int Document::AddNewProperty | ( | Property & | newProperty | ) |
Adds a given property to a given document.
newProperty | Property to be added to the document |
CEIException |
int Document::AddNewVariable | ( | Variable & | newVariable | ) |
Adds a given variable to a given document.
newVariable | Variable to be added to the document |
CEIException |
None Document::AddUserDefinedAttribute | ( | UserDefinedAttribute | attrib | ) |
Add a user defined attribute to the document.
attrib | the user defined attribute to be added to the document |
None Document::BeginUndoGroup | ( | ) |
Begins an undo group on this document.
None Document::ClearRedoAndRebuildHistory | ( | ) |
Clears all undo items ahead of the current action.
CEIException |
None Document::ClearSelections | ( | ) |
Clears selections of the objects within the document.
None Document::Close | ( | ) |
Closes this document.
CEIException |
None Document::CloseAllDocuments | ( | ) |
Closes all open documents.
None Document::CodeGenerate | ( | None | ) |
Generates the code for a given document.
CEIException |
None Document::CodeGenerateAll | ( | None | ) |
Generates all of the code for a given document.
CEIException |
None Document::CodeGenerateChildren | ( | None | ) |
Generates all of the code for a given document and any referenced children.
CEIException |
None Document::CodeGenerateClean | ( | None | ) |
Cleans the code for a given document.
CEIException |
None Document::CodeGenerateCleanAll | ( | None | ) |
Cleans all of the code for a given document.
CEIException |
None Document::CodeGenerateCleanChildren | ( | None | ) |
Cleans the code for a given document and any referenced children.
CEIException |
None Document::ConvertSelectedToMesh | ( | ) |
Converts the selected objects into a GLTriMesh.
CEIException |
None Document::CopySelectedCodeItem | ( | ) |
Copies the selected code item to the clipboard.
CEIException |
None Document::CopySelectedObjects | ( | ) |
Copies the selected objects to the clipboard.
CEIException |
None Document::CutSelectedObjects | ( | ) |
Cuts the selected objects to the clipboard.
CEIException |
None Document::DeleteMaterial | ( | int | materialIndex | ) |
Deletes a specific material from a given document.
materialIndex | index of the material to be deleted |
CEIException |
None Document::DeleteMethod | ( | int | methodIndex | ) |
Deletes a specific method from a given document.
methodIndex | index of the method to be deleted |
CEIException |
None Document::DeleteObject | ( | DisplayObject * | obj | ) |
Delete the given object from the document.
Once the object is deleted, all references to the object will be NULL.
obj | object to delete |
None Document::DeleteProperty | ( | int | propertyIndex | ) |
Deletes a specific property from a given document.
propertyIndex | index of the property to be deleted |
CEIException |
None Document::DeleteSelectedCodeItem | ( | ) |
Deletes the selected code item.
CEIException |
None Document::DeleteSelectedObjects | ( | ) |
Deletes the selected objects.
CEIException |
None Document::DeleteUserDefinedAttributeByIndex | ( | int | index | ) |
Deletes a user defined attribute from the document at a given index.
index | index of the user defined attribute to be deleted |
None Document::DeleteUserDefinedAttributeByName | ( | str | name | ) |
Deletes a user defined attribute from the document with a given name.
name | name of the user defined attribute to delete |
None Document::DeleteVariable | ( | int | variableIndex | ) |
Deletes a specific variable from a given document.
variableIndex | index of the variable to be deleted |
CEIException |
None Document::DuplicateSelectedCodeItem | ( | ) |
Duplicates the selected code item.
CEIException |
None Document::DuplicateSelectedObjects | ( | ) |
Duplicates the selected objects.
CEIException |
None Document::EnableUserDefinedBaseClass | ( | bool | enableUserDefinedBaseClass | ) |
Enables/disables user defined base class.
enableUserDefinedBaseClass | true to enable |
None Document::EndUndoGroup | ( | str | undoGroupDescription | ) |
Ends an undo group on this document.
undoGroupDescription | description of undo group |
GlsColor Document::FillColor | ( | ) |
Gets the currently selected fill color of the document.
None Document::FillColor | ( | GlsColor | color | ) |
Sets the document's current fill color, and applies it to any selected objects.
color | fill color to be applied to the Display Object |
None Document::FindInDocument | ( | str | objectName, |
str | className, | ||
str | attributeName, | ||
str | propertyValue, | ||
int | comparitorType, | ||
bool | matchCase, | ||
bool | matchEntireWord, | ||
bool | searchSelectionOnly | ||
) |
Searches the document for all objects which conform to the given parameters.
If the attributeName parameter is non-empty, the search is performed on each object's attributes. Otherwise, the search is performed on each object's object name and/or class name, depending on if either or both are specified. All objects that match the search criteria become selected; non-matching objects are deselected.
objectName | The object name for which to search, or None to not search by object name |
className | The class name for which to search, or None to not search by class name |
attributeName | The attribute name for which to search, or None to not search by attribute name |
propertyValue | The property value for which to search when searching by attribute |
comparitorType | The property value comparison mode to use when searching by attribute (1 = equal, 2 = not-equal) |
matchCase | The match case flag (If False, case is ignored while searching) |
matchEntireWord | The match entire word flag (If False, the specified object and/or class names will match substrings of the object name/class name) |
searchSelectionOnly | The search selection only flag (If True, only currently selected objects are searched) |
CEIException |
str Document::GetApplicationWindowTitle | ( | ) |
Gets the application tab 'window title' setting.
GlsColor Document::GetBackgroundColor | ( | ) |
Gets the background color for this document.
CodeGenerationMode Document::GetCodeGenerationMode | ( | ) |
Gets the code generation mode.
str Document::GetCodeOutputPath | ( | ) |
Gets the code generation code output path.
str Document::GetComponentHeaderFile | ( | ) |
Gets the code generation tab 'component header file' setting.
str Document::GetComponentSourceFile | ( | ) |
Gets the code generation tab 'component source file' setting.
list Document::GetCurrentCodeSelectionList | ( | ) |
Document Document::GetCurrentDocument | ( | ) |
Gets the current document.
str Document::GetDerivedClass | ( | ) |
Gets the code generation tab 'Derived Class' setting.
str Document::GetDirname | ( | ) |
Gets the directory of this document without the filename.
Document Document::GetDocumentByName | ( | str | docName | ) |
Gets the document with the given name, if open.
str Document::GetDocumentCalculateCommentstr | ( | ) |
Retrieves the comment for the Calculate method for a given document.
CEIException |
str Document::GetDocumentCalculatestr | ( | ) |
Retrieves the body for the Calculate method for a given document.
CEIException |
str Document::GetDocumentClassDeclarationstr | ( | ) |
Retrieves the code class declaration for a given document.
CEIException |
str Document::GetDocumentHeaderstr | ( | ) |
Retrieves the code header for a given document.
CEIException |
DocumentInfo Document::GetDocumentInfo | ( | ) |
Gets the document info for this document.
str Document::GetDocumentInitializeCommentstr | ( | ) |
Retrieves the comment for the Initialize method for a given document.
CEIException |
str Document::GetDocumentInitializestr | ( | ) |
Retrieves the body for the Initialize method for a given document.
CEIException |
str Document::GetDocumentMainInitstr | ( | ) |
Retrieves the main init for a given document.
CEIException |
str Document::GetDocumentMainLoopstr | ( | ) |
Retrieves the main loop for a given document.
CEIException |
str Document::GetDocumentRootName | ( | ) |
Retrieves the document's root name.
CEIException |
str Document::GetDocumentSourcestr | ( | ) |
Retrieves the code source for a given document.
CEIException |
str Document::GetEditorGenerationMode | ( | ) |
Retrieves the current editor generation mode.
CEIException |
str Document::GetFilename | ( | ) |
Gets the filename of this document without the directory.
FontPalette Document::GetFontPalette | ( | ) |
Gets the font palette for this document.
FrameBufferType Document::GetFrameBufferType | ( | ) |
Gets the application tab 'frame buffer type' setting.
int Document::GetFrameRate | ( | ) |
Gets the application tab 'frame rate' setting.
str Document::GetGeometryFilterText | ( | ) |
Returns the current string held by the geometry browser filter.
str Document::GetIdlDeclarationUserCode | ( | ) |
Get the IDL declaration user code.
str Document::GetIdlFileUserCode | ( | ) |
Get the IDL file user code.
str Document::GetInitialEyePointName | ( | ) |
Gets the application tab 'inital eyepoint name' setting.
int Document::GetInitialHeight | ( | ) |
Gets the application tab 'initial height' setting.
int Document::GetInitialPositionX | ( | ) |
Gets the application tab 'initial position x' setting.
int Document::GetInitialPositionY | ( | ) |
Gets the application tab 'initial position y' setting.
int Document::GetInitialWidth | ( | ) |
Gets the application tab 'initial width' setting.
Vector Document::GetLastMouseDownPositionLogical | ( | ) |
Material Document::GetMaterial | ( | int | materialIndex | ) |
Retrieves a specific material for a given document.
materialIndex | index of the desired material |
CEIException |
int Document::GetMaximumHeight | ( | ) |
Gets the application tab 'maximum height' setting.
int Document::GetMaximumWidth | ( | ) |
Gets the application tab 'maximum width' setting.
Method Document::GetMethod | ( | int | methodIndex | ) |
Retrieves a specific method for a given document.
methodIndex | index of the desired method |
CEIException |
int Document::GetMinimumHeight | ( | ) |
Gets the application tab 'minimum height' setting.
int Document::GetMinimumWidth | ( | ) |
Gets the application tab 'minimum width' setting.
int Document::GetNumMaterials | ( | ) |
Retrieves the number of materials for a given document.
CEIException |
int Document::GetNumMethods | ( | ) |
Retrieves the number of methods for a given document.
CEIException |
int Document::GetNumObjects | ( | ) |
Gets the number of objects within a given document.
CEIException |
int Document::GetNumProperties | ( | ) |
Retrieves the number of properties for a given document.
CEIException |
int Document::GetNumUserDefinedAttributes | ( | ) |
Gets the number of user defined attributes in the document.
int Document::GetNumVariables | ( | ) |
Retrieves the number of variables for a given document.
CEIException |
DisplayObject * Document::GetObjectByName | ( | str | name | ) |
Finds an object within a document.
name | string containing the name of the object to find |
CEIException |
Group * Document::GetObjectList | ( | ) |
Returns a group of all objects in the document hierarchy.
CEIException |
ProjectionMode Document::GetProjectionMode | ( | ) |
Gets the application tab 'projection mode' setting.
Property Document::GetProperty | ( | int | propertyIndex | ) |
Retrieves a specific property for a given document.
propertyIndex | index of the desired property |
CEIException |
str Document::GetPropertyFilterText | ( | ) |
Returns the current string held by the object property table filter.
RedrawMode Document::GetRedrawMode | ( | ) |
Gets the application tab 'redraw mode' setting.
str Document::GetResources | ( | ) |
Gets all of the resources of all of the objects within this document.
RuntimeAttributesFlags Document::GetRuntimeAttributes | ( | ) |
Gets the resources tab 'runtime attributes' setting.
DisplayObjectArray * Document::GetSelectedObjects | ( | ) |
Gets all selected objects in the document.
SoundList Document::GetSoundList | ( | ) |
Gets the sound list for this document.
str Document::GetStandaloneHeaderFile | ( | ) |
Gets the code generation tab 'standalone header file' setting.
str Document::GetStandaloneInstanceName | ( | ) |
Gets the code generation tab 'standalone instance name' setting.
str Document::GetStandaloneMainFile | ( | ) |
Get the code generation tab 'standalone main file' setting.
str Document::GetStandaloneSourceFile | ( | ) |
Gets the code generation tab 'standalone source file' setting.
TexturePalette Document::GetTexturePalette | ( | ) |
Gets the texture palette for this document.
UserDefinedAttribute Document::GetUserDefinedAttributeByGuid | ( | str | guid | ) |
Gets a user defined attribute within the document by guid.
guid | guid of the user defined attribute to retrieve |
UserDefinedAttribute Document::GetUserDefinedAttributeByIndex | ( | int | index | ) |
Gets a user defined attribute within the document by index.
index | index of the user defined attribute to retrieve |
str Document::GetUserDefinedBaseClass | ( | ) |
Gets the user defined base class used in component code generation mode if user defined base class is enabled.
str Document::GetUserDefinedBaseClassConstructorInit | ( | ) |
Gets the code generation tab 'user defined base class ructor init' setting.
Variable Document::GetVariable | ( | int | variableIndex | ) |
Retrieves a specific variable for a given document.
variableIndex | index of the desired variable |
CEIException |
bool Document::HasAccumulationBuffer | ( | ) |
Gets the application tab 'accumulation buffer' setting.
bool Document::HasAlphaInColorBuffer | ( | ) |
Gets the application tab 'alpha in color buffer' setting.
bool Document::HasBorder | ( | ) |
Gets the application tab 'has border' setting.
bool Document::HasDepthBuffer | ( | ) |
Gets the application tab 'depth buffer' setting.
bool Document::HasMultisampleBuffer | ( | ) |
Gets the application tab 'multisample buffer' setting.
bool Document::HasStencilBuffer | ( | ) |
Gets the application tab 'stencil buffer' setting.
bool Document::HasVisibleTab | ( | ) |
Determines whether the given doc has a visible tab.
None Document::HideTab | ( | ) |
Hides this document's tab, and shows the next open document.
If there are no other open documents, does nothing.
None Document::InsertComponent | ( | ComponentRef & | comp | ) |
Adds a component to the document.
comp | pointer to the component to be added to the document |
CEIException |
ComponentRef * Document::InsertComponent | ( | str | filename | ) |
Adds a file as a component to the document.
filename | string containing the filename of the component to insert into the document |
CEIException |
None Document::InsertObject | ( | DisplayObject * | obj, |
bool | renameName = false |
||
) |
Inserts the given object to the document.
obj | object to insert |
renameName | allows the object's name to be renamed during insertion to maintain uniqueness. If a duplicate name is found in the document, the function will rename the object based on its current name. If flag is not set, then an exception is thrown when another object already has the same name. Default - False |
bool Document::IsCodeGenerationFillInFromRoot | ( | ) |
Gets the code generation tab 'fill in from root' setting.
bool Document::isEqual | ( | Document * | rhs | ) |
Determines if wrapped document is equal to another wrapped document.
rhs | The document to compare to this |
bool Document::IsFullScreen | ( | ) |
Gets the application tab 'full screen' setting.
bool Document::IsGenerateMainInSeparateFile | ( | ) |
Determines whether the main is generated in a separate file.
bool Document::IsGenerateSourceComments | ( | ) |
Gets the code generation tab 'generate source comments' setting.
bool Document::isNULL | ( | ) |
Determines if wrapped document does not exist.
bool Document::IsResizable | ( | ) |
Gets the application tab 'resizable' setting.
bool Document::IsUserDefinedBaseClassEnabled | ( | ) |
Determines if user defined base class is enabled.
bool Document::IsViewCulling | ( | ) |
Gets the application tab 'view culling' setting.
GlsColor Document::LineColor | ( | ) |
Gets the currently selected line color for the document.
None Document::LineColor | ( | GlsColor | color | ) |
Sets the document's current line color, and applies it to any selected objects.
color | line color to be applied to the document |
None Document::LoadUserDefinedAttributes | ( | str | filename | ) |
Reads user defined attributes from a file.
filename | name of the file from which the user defined attributes are to be read |
None Document::MakeCurrentDocument | ( | ) |
Makes this document the current document.
CEIException |
Document Document::NewDocument | ( | str | fileName = "" | ) |
Creates a new document and makes it the current document.
fileName | optional filename to give the new document |
Document Document::OpenDocument | ( | str | fileName, |
bool | showTab = true |
||
) |
Opens a new document and makes it the current document.
fileName | name of file to load |
showTab | whether or not to show the file in a tab. If false, will open it in the background. |
None Document::PasteClipboardCodeItem | ( | ) |
Pastes the code item from the clipboard.
CEIException |
None Document::PasteClipboardObjects | ( | bool | keepNames, |
bool | keepPositions | ||
) |
Pastes the objects from the clipboard.
keepNames | true to keep object names (deprecated and ignored) |
keepPositions | true to keep object positions |
CEIException |
None Document::PasteClipboardObjects | ( | bool | keepPositions | ) |
Pastes the objects from the clipboard.
keepPositions | true to keep object positions |
CEIException |
None Document::RedoAction | ( | ) |
Redo the previously undone action.
CEIException |
None Document::Save | ( | ) |
Saves this document.
CEIException |
None Document::SaveAllDocuments | ( | ) |
Saves all open documents.
None Document::SaveAs | ( | str | fileName | ) |
save this document with a given filename.
If no filename is specified, a popup will appear.
CEIException |
None Document::SaveUserDefinedAttributes | ( | str | filename | ) |
Writes user defined attributes to a file.
filename | name of the file to which the user defined attributes are to be written |
None Document::SelectAll | ( | ) |
Selects all of the objects within the document.
None Document::SelectObject | ( | DisplayObject * | obj | ) |
Selects the object within the editor.
obj | the object to be selected |
None Document::SelectObjects | ( | DisplayObjectArray * | objs | ) |
Selects the objects within the editor, adding to current selection.
objs | the object array to be selected |
None Document::SelectObjects | ( | list | objectNames, |
bool | addToCurrentSelection = false |
||
) |
Selects the specified objects.
objectNames | the list object names. |
addToCurrentSelection | if true, adds the specified objects to the pre-existing selection. If false, it clears the pre-existing selection before selecting the specified objects. |
None Document::SetAccumulationBuffer | ( | bool | accumulationBuffer | ) |
Sets the application tab 'accumulation buffer' setting.
accumulationBuffer | accumulation buffer setting |
None Document::SetAlphaInColorBuffer | ( | bool | alphaInColorBuffer | ) |
Sets the application tab 'alpha in color buffer' setting.
alphaInColorBuffer | alpha in color buffer setting |
None Document::SetApplicationWindowTitle | ( | str | title | ) |
Sets the application tab 'window title' setting.
title | window title |
None Document::SetBackgroundColor | ( | GlsColor | color | ) |
Sets the document's background color.
color | the color for the background |
None Document::SetBackgroundColor | ( | int | r, |
int | g, | ||
int | b, | ||
int | a | ||
) |
Sets the document's background color.
r | red color for the background |
g | green color for the background |
b | blue color for the background |
a | alpha color for the background |
None Document::SetCodeGenerationFillInFromRoot | ( | bool | fillInFromRoot | ) |
Sets the code generation tab 'fill in from root' setting.
fillInFromRoot | true to fill in from root |
None Document::SetCodeGenerationMode | ( | CodeGenerationMode | codeGenerationMode | ) |
Sets the code generation mode.
codeGenerationMode | code generation mode |
None Document::SetCodeOutputPath | ( | str | codeOutputPath | ) |
Sets the code generation code output path.
codeOutputPath | the code generation code output path |
None Document::SetComponentHeaderFile | ( | str | headerFile | ) |
Sets the code generation tab 'component header file' setting.
headerFile | component header file |
None Document::SetComponentSourceFile | ( | str | sourceFile | ) |
Sets the code generation tab 'component source file' setting.
sourceFile | component source file |
None Document::SetDepthBuffer | ( | bool | depthBuffer | ) |
Sets the application tab 'depth buffer' setting.
depthBuffer | depth buffer setting |
None Document::SetDerivedClass | ( | str | derivedClass | ) |
Sets the code generation tab 'Derived Class' setting.
derivedClass | derived class name |
None Document::SetDirtyFlag | ( | ) |
Mark this document as dirty.
CEIException |
None Document::SetDocumentCalculatestr | ( | str | str | ) |
Sets the body for the Calculate method for a given document.
str | str to be used in the body |
CEIException |
None Document::SetDocumentClassDeclarationstr | ( | str | str | ) |
Sets the code class declaration for a given document.
str | str to be added to the class declaration |
CEIException |
None Document::SetDocumentHeaderstr | ( | str | str | ) |
Sets the code header for a given document.
str | str to be added at the beginning of the code header |
CEIException |
None Document::SetDocumentInitializestr | ( | str | str | ) |
Sets the body for the Initialize method for a given document.
str | str to be used in the body |
CEIException |
None Document::SetDocumentMainInitstr | ( | str | str | ) |
Sets the main init for a given document.
str | str to be used in the main init |
CEIException |
None Document::SetDocumentMainLoopstr | ( | str | str | ) |
Sets the main loop for a given document.
str | str to be used in the main loop |
CEIException |
None Document::SetDocumentRootName | ( | str | rootName | ) |
Sets the document's root name.
CEIException |
None Document::SetDocumentSaved | ( | ) |
Clears the dirty flag without updating the document.
CEIException |
None Document::SetDocumentSourcestr | ( | str | str | ) |
Sets the code source for a given document.
str | str to be added at the beginning of the code source |
CEIException |
None Document::SetEditorGenerationMode | ( | str | str | ) |
Sets the current editor generation mode.
str | str specifiying the new editor mode |
CEIException |
None Document::SetFrameBufferType | ( | FrameBufferType | frameBufferType | ) |
Sets the application tab 'frame buffer type' setting.
frameBufferType | frame buffer type |
None Document::SetFrameRate | ( | int | frameRateHz | ) |
Sets the application tab 'frame rate' setting.
frameRateHz | frame rate in hz |
None Document::SetFullScreen | ( | bool | fullScreen | ) |
Sets the application tab 'full screen' setting.
fullScreen | full screen setting |
None Document::SetGenerateMainInSeparateFile | ( | bool | separateFile | ) |
Sets whether the main is generated in a separate file.
separateFile | true to generate main in a seperate file |
None Document::SetGenerateSourceComments | ( | bool | generateSourceComments | ) |
Sets the code generation tab 'generate source comments' setting.
generateSourceComments | true to generate source comments |
None Document::SetHasBorder | ( | bool | hasBorder | ) |
Sets the application tab 'has border' setting.
hasBorder | has border setting |
None Document::SetIdlDeclarationUserCode | ( | str | idlDeclarationUserCode | ) |
Set the IDL declaration user code.
idlDeclarationUserCode | the IDL declaration user code |
None Document::SetIdlFileUserCode | ( | str | idlFileUserCode | ) |
Set the IDL file user code.
idlFileUserCode | the IDL file user code |
None Document::SetInitialEyePointName | ( | str | eyePointName | ) |
Sets the application tab 'inital eyepoint name' setting.
eyePointName | eye point name |
None Document::SetInitialHeight | ( | int | height | ) |
Sets the application tab 'initial height' setting.
height | initial height |
None Document::SetInitialPositionX | ( | int | x | ) |
Sets the application tab 'initial position x' setting.
x | initial position x |
None Document::SetInitialPositionY | ( | int | y | ) |
Sets the application tab 'initial position y' setting.
y | initial position y |
None Document::SetInitialWidth | ( | int | width | ) |
Sets the application tab 'initial width' setting.
width | initial width |
None Document::SetMaximumHeight | ( | int | height | ) |
Sets the application tab 'maximum height' setting.
height | max height |
None Document::SetMaximumWidth | ( | int | width | ) |
Sets the application tab 'maximum width' setting.
width | max width |
None Document::SetMinimumHeight | ( | int | height | ) |
Sets the application tab 'minimum height' setting.
height | min height |
None Document::SetMinimumWidth | ( | int | width | ) |
Sets the application tab 'minimum width' setting.
width | min width |
None Document::SetMultisampleBuffer | ( | bool | multisampleBuffer | ) |
Sets the application tab 'multisample buffer' setting.
multisampleBuffer | multisample buffer setting |
None Document::SetProjectionMode | ( | ProjectionMode | projectionMode | ) |
Sets the application tab 'projection mode' setting.
projectionMode | projection mode |
None Document::SetRedrawMode | ( | RedrawMode | redrawMode | ) |
Sets the application tab 'redraw mode' setting.
redrawMode | redraw mode |
None Document::SetResizable | ( | bool | resizable | ) |
Sets the application tab 'resizable' setting.
resizable | resizable setting |
None Document::SetRuntimeAttributes | ( | RuntimeAttributesFlags | flags | ) |
Sets the resources tab 'runtime attributes' setting.
flags | runtime attribute flags |
None Document::SetStandaloneHeaderFile | ( | str | headerFile | ) |
Sets the code generation tab 'standalone header file' setting.
headerFile | standalone header file |
None Document::SetStandaloneInstanceName | ( | str | instanceName | ) |
Sets the code generation tab 'standalone instance name' setting.
instanceName | standalone instance name |
None Document::SetStandaloneMainFile | ( | str | mainFile | ) |
Set the code generation tab 'standalone main file' setting.
mainFile | main file |
None Document::SetStandaloneSourceFile | ( | str | sourceFile | ) |
Sets the code generation tab 'standalone source file' setting.
sourceFile | standalone source file |
None Document::SetStencilBuffer | ( | bool | stencilBuffer | ) |
Sets the application tab 'stencil buffer' setting.
stencilBuffer | stencil buffer setting |
None Document::SetUserDefinedBaseClass | ( | str | userDefinedBaseClass | ) |
Sets the user defined base class used in component code generation mode if user defined base class is enabled.
userDefinedBaseClass | user defined base class |
None Document::SetUserDefinedBaseClassConstructorInit | ( | str | ctorInit | ) |
Sets the code generation tab 'user defined base class ructor init' setting.
ctorInit | the code generation tab 'user defined base class ructor init' setting |
None Document::SetViewCulling | ( | bool | viewCulling | ) |
Sets the application tab 'view culling' setting.
viewCulling | view culling setting |
None Document::UndoAction | ( | ) |
Undo the previous action.
CEIException |
None Document::UnselectObject | ( | DisplayObject * | obj | ) |
Unselects the object within the editor.
obj | the object to be unselected |
None Document::UnselectObjects | ( | DisplayObjectArray * | objs | ) |
Unselects the objects within the editor.
objs | the object array to be unselected |
None Document::UpdateMaterial | ( | int | materialIndex, |
Material | matUpdates | ||
) |
Updates a specific material for a given document.
materialIndex | index of the material to be updated |
matUpdates | material containing the updated material information |
CEIException |
None Document::UpdateUserDefinedAttribute | ( | UserDefinedAttribute | attrib | ) |
Updates a user defined attribute within the document.
attrib | the user defined attribute to be updated |