Python Script Engine  8.3
GL Studio Editor Python Script API
Document Class Reference

Public Types

enum  CodeGenerationMode {
  CODE_GENERATION_MODE_STANDALONE ,
  CODE_GENERATION_MODE_COMPONENT
}
 
enum  FrameBufferType {
  FRAME_BUFFER_TYPE_SINGLE_BUFFERED ,
  FRAME_BUFFER_TYPE_DOUBLE_BUFFERED
}
 
enum  ProjectionMode {
  PROJECTION_MODE_ORTHOGRAPHIC ,
  PROJECTION_MODE_PERSPECTIVE ,
  PROJECTION_MODE_EYEPOINT
}
 
enum  RedrawMode {
  REDRAW_MODE_CONDITIONAL ,
  REDRAW_MODE_CONSTANT ,
  REDRAW_MODE_CONTINUOUS
}
 
enum  RuntimeAttributesFlags {
  RUNTIME_ATTRIBUTES_BASIC ,
  RUNTIME_ATTRIBUTES_DYNAMIC ,
  RUNTIME_ATTRIBUTES_APPEARANCE ,
  RUNTIME_ATTRIBUTES_GEOMETRY ,
  RUNTIME_ATTRIBUTES_SPECIALIZED ,
  RUNTIME_ATTRIBUTES_ALL ,
  RUNTIME_ATTRIBUTES_NONE
}
 

Public Member Functions

bool isNULL ()
 
bool isEqual (Document *rhs)
 
str GetFilename ()
 
str GetDirname ()
 
None Close ()
 
None MakeCurrentDocument ()
 
None Save ()
 
None SaveAs (str fileName)
 
None SetDirtyFlag ()
 
None SetDocumentSaved ()
 
None UndoAction ()
 
None RedoAction ()
 
None ClearRedoAndRebuildHistory ()
 
None BeginUndoGroup ()
 
None EndUndoGroup (str undoGroupDescription)
 
None InsertObject (DisplayObject *obj, bool renameName=false)
 
None DeleteObject (DisplayObject *obj)
 
DisplayObjectArrayGetSelectedObjects ()
 
list GetCurrentCodeSelectionList ()
 
Vector GetLastMouseDownPositionLogical ()
 
None SelectAll ()
 
None ClearSelections ()
 
None SelectObject (DisplayObject *obj)
 
None SelectObjects (DisplayObjectArray *objs)
 
None SelectObjects (list objectNames, bool addToCurrentSelection=false)
 
None UnselectObject (DisplayObject *obj)
 
None UnselectObjects (DisplayObjectArray *objs)
 
None SetCodeGenerationFillInFromRoot (bool fillInFromRoot)
 
bool IsCodeGenerationFillInFromRoot ()
 
None SetDocumentRootName (str rootName)
 
str GetDocumentRootName ()
 
None SetDerivedClass (str derivedClass)
 
str GetDerivedClass ()
 
None SetIdlFileUserCode (str idlFileUserCode)
 
str GetIdlFileUserCode ()
 
None SetIdlDeclarationUserCode (str idlDeclarationUserCode)
 
str GetIdlDeclarationUserCode ()
 
None SetCodeOutputPath (str codeOutputPath)
 
str GetCodeOutputPath ()
 
None SetGenerateSourceComments (bool generateSourceComments)
 
bool IsGenerateSourceComments ()
 
None SetCodeGenerationMode (CodeGenerationMode codeGenerationMode)
 
CodeGenerationMode GetCodeGenerationMode ()
 
None SetStandaloneInstanceName (str instanceName)
 
str GetStandaloneInstanceName ()
 
None SetStandaloneHeaderFile (str headerFile)
 
str GetStandaloneHeaderFile ()
 
None SetStandaloneSourceFile (str sourceFile)
 
str GetStandaloneSourceFile ()
 
None SetGenerateMainInSeparateFile (bool separateFile)
 
bool IsGenerateMainInSeparateFile ()
 
None SetStandaloneMainFile (str mainFile)
 
str GetStandaloneMainFile ()
 
None SetComponentHeaderFile (str headerFile)
 
str GetComponentHeaderFile ()
 
None SetComponentSourceFile (str sourceFile)
 
str GetComponentSourceFile ()
 
None SetUserDefinedBaseClass (str userDefinedBaseClass)
 
str GetUserDefinedBaseClass ()
 
None EnableUserDefinedBaseClass (bool enableUserDefinedBaseClass)
 
bool IsUserDefinedBaseClassEnabled ()
 
None SetUserDefinedBaseClassConstructorInit (str ctorInit)
 
str GetUserDefinedBaseClassConstructorInit ()
 
None SetApplicationWindowTitle (str title)
 
str GetApplicationWindowTitle ()
 
None SetInitialPositionX (int x)
 
int GetInitialPositionX ()
 
None SetInitialPositionY (int y)
 
int GetInitialPositionY ()
 
None SetInitialWidth (int width)
 
int GetInitialWidth ()
 
None SetInitialHeight (int height)
 
int GetInitialHeight ()
 
None SetMaximumWidth (int width)
 
int GetMaximumWidth ()
 
None SetMaximumHeight (int height)
 
int GetMaximumHeight ()
 
None SetMinimumWidth (int width)
 
int GetMinimumWidth ()
 
None SetMinimumHeight (int height)
 
int GetMinimumHeight ()
 
None SetFrameBufferType (FrameBufferType frameBufferType)
 
FrameBufferType GetFrameBufferType ()
 
None SetHasBorder (bool hasBorder)
 
bool HasBorder ()
 
None SetResizable (bool resizable)
 
bool IsResizable ()
 
None SetStencilBuffer (bool stencilBuffer)
 
bool HasStencilBuffer ()
 
None SetDepthBuffer (bool depthBuffer)
 
bool HasDepthBuffer ()
 
None SetMultisampleBuffer (bool multisampleBuffer)
 
bool HasMultisampleBuffer ()
 
None SetAccumulationBuffer (bool accumulationBuffer)
 
bool HasAccumulationBuffer ()
 
None SetAlphaInColorBuffer (bool alphaInColorBuffer)
 
bool HasAlphaInColorBuffer ()
 
None SetFullScreen (bool fullScreen)
 
bool IsFullScreen ()
 
None SetViewCulling (bool viewCulling)
 
bool IsViewCulling ()
 
None SetProjectionMode (ProjectionMode projectionMode)
 
ProjectionMode GetProjectionMode ()
 
None SetInitialEyePointName (str eyePointName)
 
str GetInitialEyePointName ()
 
None SetRedrawMode (RedrawMode redrawMode)
 
RedrawMode GetRedrawMode ()
 
None SetFrameRate (int frameRateHz)
 
int GetFrameRate ()
 
GlsColor GetBackgroundColor ()
 
None SetBackgroundColor (GlsColor color)
 
None SetBackgroundColor (int r, int g, int b, int a)
 
None SetRuntimeAttributes (RuntimeAttributesFlags flags)
 
RuntimeAttributesFlags GetRuntimeAttributes ()
 
TexturePalette GetTexturePalette ()
 
SoundList GetSoundList ()
 
FontPalette GetFontPalette ()
 
DocumentInfo GetDocumentInfo ()
 
None FindInDocument (str objectName, str className, str attributeName, str propertyValue, int comparitorType, bool matchCase, bool matchEntireWord, bool searchSelectionOnly)
 
None CodeGenerate (None)
 
None CodeGenerateChildren (None)
 
None CodeGenerateAll (None)
 
None CodeGenerateClean (None)
 
None CodeGenerateCleanChildren (None)
 
None CodeGenerateCleanAll (None)
 
None SetEditorGenerationMode (str str)
 
str GetEditorGenerationMode ()
 
None SetDocumentHeaderstr (str str)
 
str GetDocumentHeaderstr ()
 
None SetDocumentSourcestr (str str)
 
str GetDocumentSourcestr ()
 
None SetDocumentClassDeclarationstr (str str)
 
str GetDocumentClassDeclarationstr ()
 
None SetDocumentMainLoopstr (str str)
 
str GetDocumentMainLoopstr ()
 
None SetDocumentMainInitstr (str str)
 
str GetDocumentMainInitstr ()
 
None SetDocumentInitializestr (str str)
 
str GetDocumentInitializestr ()
 
str GetDocumentInitializeCommentstr ()
 
None SetDocumentCalculatestr (str str)
 
str GetDocumentCalculatestr ()
 
str GetDocumentCalculateCommentstr ()
 
int AddNewProperty (Property &newProperty)
 
int GetNumProperties ()
 
Property GetProperty (int propertyIndex)
 
None DeleteProperty (int propertyIndex)
 
int AddNewMethod (Method &newMethod)
 
int GetNumMethods ()
 
Method GetMethod (int methodIndex)
 
None DeleteMethod (int methodIndex)
 
int AddNewVariable (Variable &newVariable)
 
int GetNumVariables ()
 
Variable GetVariable (int variableIndex)
 
None DeleteVariable (int variableIndex)
 
int AddNewMaterial (Material &newMaterial)
 
int GetNumMaterials ()
 
Material GetMaterial (int materialIndex)
 
None UpdateMaterial (int materialIndex, Material matUpdates)
 
None DeleteMaterial (int materialIndex)
 
int GetNumObjects ()
 
DisplayObjectGetObjectByName (str name)
 
GroupGetObjectList ()
 
ComponentRefInsertComponent (str filename)
 
None InsertComponent (ComponentRef &comp)
 
None CutSelectedObjects ()
 
None DeleteSelectedObjects ()
 
None CopySelectedObjects ()
 
None PasteClipboardObjects (bool keepNames, bool keepPositions)
 
None PasteClipboardObjects (bool keepPositions)
 
None DuplicateSelectedObjects ()
 
None CopySelectedCodeItem ()
 
None PasteClipboardCodeItem ()
 
None DuplicateSelectedCodeItem ()
 
None DeleteSelectedCodeItem ()
 
None ConvertSelectedToMesh ()
 
GlsColor LineColor ()
 
None LineColor (GlsColor color)
 
GlsColor FillColor ()
 
None FillColor (GlsColor color)
 
None AddUserDefinedAttribute (UserDefinedAttribute attrib)
 
int GetNumUserDefinedAttributes ()
 
UserDefinedAttribute GetUserDefinedAttributeByIndex (int index)
 
UserDefinedAttribute GetUserDefinedAttributeByGuid (str guid)
 
None DeleteUserDefinedAttributeByIndex (int index)
 
None DeleteUserDefinedAttributeByName (str name)
 
None UpdateUserDefinedAttribute (UserDefinedAttribute attrib)
 
None LoadUserDefinedAttributes (str filename)
 
None SaveUserDefinedAttributes (str filename)
 
str GetResources ()
 
bool HasVisibleTab ()
 
None HideTab ()
 
str GetGeometryFilterText ()
 
str GetPropertyFilterText ()
 

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)
 

Detailed Description

common editor interface document

Member Enumeration Documentation

◆ CodeGenerationMode

Code generation modes.

Enumerator
CODE_GENERATION_MODE_STANDALONE 
CODE_GENERATION_MODE_COMPONENT 

◆ FrameBufferType

Frame buffer types.

Enumerator
FRAME_BUFFER_TYPE_SINGLE_BUFFERED 
FRAME_BUFFER_TYPE_DOUBLE_BUFFERED 

◆ ProjectionMode

Projection modes.

Enumerator
PROJECTION_MODE_ORTHOGRAPHIC 
PROJECTION_MODE_PERSPECTIVE 
PROJECTION_MODE_EYEPOINT 

◆ RedrawMode

Redraw modes.

Enumerator
REDRAW_MODE_CONDITIONAL 
REDRAW_MODE_CONSTANT 
REDRAW_MODE_CONTINUOUS 

◆ RuntimeAttributesFlags

Runtime attributes flags.

Enumerator
RUNTIME_ATTRIBUTES_BASIC 
RUNTIME_ATTRIBUTES_DYNAMIC 
RUNTIME_ATTRIBUTES_APPEARANCE 
RUNTIME_ATTRIBUTES_GEOMETRY 
RUNTIME_ATTRIBUTES_SPECIALIZED 
RUNTIME_ATTRIBUTES_ALL 
RUNTIME_ATTRIBUTES_NONE 

Member Function Documentation

◆ AddNewMaterial()

int Document::AddNewMaterial ( Material newMaterial)

Adds a given material to a given document.

Parameters
newMaterialMaterial to be added to the document
Returns
-1 if an error occurred while adding the material; otherwise 0 if material is successfully added
Exceptions
CEIException

◆ AddNewMethod()

int Document::AddNewMethod ( Method newMethod)

Adds a given method to a given document.

Parameters
newMethodMethod to be added to the document
Returns
-1 if an error occurred while adding the method; otherwise 0 if method is successfully added
Exceptions
CEIException

◆ AddNewProperty()

int Document::AddNewProperty ( Property newProperty)

Adds a given property to a given document.

Parameters
newPropertyProperty to be added to the document
Returns
-1 if an error occurred while adding the property; otherwise 0 if property is successfully added
Exceptions
CEIException

◆ AddNewVariable()

int Document::AddNewVariable ( Variable newVariable)

Adds a given variable to a given document.

Parameters
newVariableVariable to be added to the document
Returns
-1 if an error occurred while adding the variable; otherwise 0 if variable is successfully added
Exceptions
CEIException

◆ AddUserDefinedAttribute()

None Document::AddUserDefinedAttribute ( UserDefinedAttribute  attrib)

Add a user defined attribute to the document.

Parameters
attribthe user defined attribute to be added to the document

◆ BeginUndoGroup()

None Document::BeginUndoGroup ( )

Begins an undo group on this document.

◆ ClearRedoAndRebuildHistory()

None Document::ClearRedoAndRebuildHistory ( )

Clears all undo items ahead of the current action.

Precondition
!isNULL()
Exceptions
CEIException

◆ ClearSelections()

None Document::ClearSelections ( )

Clears selections of the objects within the document.

Precondition
!isNULL()

◆ Close()

None Document::Close ( )

Closes this document.

Precondition
!isNULL()
Exceptions
CEIException
Note
current document is set to a different document if this doc is the current doc
Postcondition
isNULL will return true for this document after calling Close()

◆ CloseAllDocuments()

None Document::CloseAllDocuments ( )

Closes all open documents.

Deprecated:
Use Editor.CloseAllDocuments() instead.

◆ CodeGenerate()

None Document::CodeGenerate ( None  )

Generates the code for a given document.

Exceptions
CEIException
Deprecated:
Use Editor.GenerateCurrentDocument() instead.

◆ CodeGenerateAll()

None Document::CodeGenerateAll ( None  )

Generates all of the code for a given document.

Exceptions
CEIException
Deprecated:
Use Editor.GenerateAllDocuments() instead.

◆ CodeGenerateChildren()

None Document::CodeGenerateChildren ( None  )

Generates all of the code for a given document and any referenced children.

Exceptions
CEIException
Deprecated:
Use Editor.GenerateCurrentDocumentAndChildren() instead.

◆ CodeGenerateClean()

None Document::CodeGenerateClean ( None  )

Cleans the code for a given document.

Exceptions
CEIException
Deprecated:
Use Editor.CleanCurrentDocument() instead.

◆ CodeGenerateCleanAll()

None Document::CodeGenerateCleanAll ( None  )

Cleans all of the code for a given document.

Exceptions
CEIException
Deprecated:
Use Editor.CleanAllDocuments() instead.

◆ CodeGenerateCleanChildren()

None Document::CodeGenerateCleanChildren ( None  )

Cleans the code for a given document and any referenced children.

Exceptions
CEIException
Deprecated:
Use Editor.CleanCurrentDocumentAndChildren() instead.

◆ ConvertSelectedToMesh()

None Document::ConvertSelectedToMesh ( )

Converts the selected objects into a GLTriMesh.

Exceptions
CEIException

◆ CopySelectedCodeItem()

None Document::CopySelectedCodeItem ( )

Copies the selected code item to the clipboard.

Exceptions
CEIException

◆ CopySelectedObjects()

None Document::CopySelectedObjects ( )

Copies the selected objects to the clipboard.

Exceptions
CEIException

◆ CutSelectedObjects()

None Document::CutSelectedObjects ( )

Cuts the selected objects to the clipboard.

Exceptions
CEIException

◆ DeleteMaterial()

None Document::DeleteMaterial ( int  materialIndex)

Deletes a specific material from a given document.

Parameters
materialIndexindex of the material to be deleted
Exceptions
CEIException

◆ DeleteMethod()

None Document::DeleteMethod ( int  methodIndex)

Deletes a specific method from a given document.

Parameters
methodIndexindex of the method to be deleted
Exceptions
CEIException

◆ DeleteObject()

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.

Parameters
objobject to delete
Precondition
!isNULL()

◆ DeleteProperty()

None Document::DeleteProperty ( int  propertyIndex)

Deletes a specific property from a given document.

Parameters
propertyIndexindex of the property to be deleted
Exceptions
CEIException

◆ DeleteSelectedCodeItem()

None Document::DeleteSelectedCodeItem ( )

Deletes the selected code item.

Exceptions
CEIException
Since
GL Studio 6.0.1

◆ DeleteSelectedObjects()

None Document::DeleteSelectedObjects ( )

Deletes the selected objects.

Exceptions
CEIException

◆ DeleteUserDefinedAttributeByIndex()

None Document::DeleteUserDefinedAttributeByIndex ( int  index)

Deletes a user defined attribute from the document at a given index.

Parameters
indexindex of the user defined attribute to be deleted

◆ DeleteUserDefinedAttributeByName()

None Document::DeleteUserDefinedAttributeByName ( str  name)

Deletes a user defined attribute from the document with a given name.

Parameters
namename of the user defined attribute to delete

◆ DeleteVariable()

None Document::DeleteVariable ( int  variableIndex)

Deletes a specific variable from a given document.

Parameters
variableIndexindex of the variable to be deleted
Exceptions
CEIException

◆ DuplicateSelectedCodeItem()

None Document::DuplicateSelectedCodeItem ( )

Duplicates the selected code item.

Exceptions
CEIException

◆ DuplicateSelectedObjects()

None Document::DuplicateSelectedObjects ( )

Duplicates the selected objects.

Exceptions
CEIException

◆ EnableUserDefinedBaseClass()

None Document::EnableUserDefinedBaseClass ( bool  enableUserDefinedBaseClass)

Enables/disables user defined base class.

Parameters
enableUserDefinedBaseClasstrue to enable
Precondition
!isNULL()

◆ EndUndoGroup()

None Document::EndUndoGroup ( str  undoGroupDescription)

Ends an undo group on this document.

Parameters
undoGroupDescriptiondescription of undo group
Precondition
BeginUndoGroup was called

◆ FillColor() [1/2]

GlsColor Document::FillColor ( )

Gets the currently selected fill color of the document.

Returns
fill color of the Display Object

◆ FillColor() [2/2]

None Document::FillColor ( GlsColor  color)

Sets the document's current fill color, and applies it to any selected objects.

Parameters
colorfill color to be applied to the Display Object

◆ FindInDocument()

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.

Parameters
objectNameThe object name for which to search, or None to not search by object name
classNameThe class name for which to search, or None to not search by class name
attributeNameThe attribute name for which to search, or None to not search by attribute name
propertyValueThe property value for which to search when searching by attribute
comparitorTypeThe property value comparison mode to use when searching by attribute (1 = equal, 2 = not-equal)
matchCaseThe match case flag (If False, case is ignored while searching)
matchEntireWordThe match entire word flag (If False, the specified object and/or class names will match substrings of the object name/class name)
searchSelectionOnlyThe search selection only flag (If True, only currently selected objects are searched)
Exceptions
CEIException

◆ GetApplicationWindowTitle()

str Document::GetApplicationWindowTitle ( )

Gets the application tab 'window title' setting.

Returns
window title
Precondition
!isNULL()

◆ GetBackgroundColor()

GlsColor Document::GetBackgroundColor ( )

Gets the background color for this document.

Returns
the background color for this document

◆ GetCodeGenerationMode()

CodeGenerationMode Document::GetCodeGenerationMode ( )

Gets the code generation mode.

Returns
code generation mode
Precondition
!isNULL()

◆ GetCodeOutputPath()

str Document::GetCodeOutputPath ( )

Gets the code generation code output path.

Returns
the code generation code output path
Precondition
!isNULL()

◆ GetComponentHeaderFile()

str Document::GetComponentHeaderFile ( )

Gets the code generation tab 'component header file' setting.

Returns
component header file
Precondition
!isNULL()

◆ GetComponentSourceFile()

str Document::GetComponentSourceFile ( )

Gets the code generation tab 'component source file' setting.

Returns
standalone source file
Precondition
!isNULL()

◆ GetCurrentCodeSelectionList()

list Document::GetCurrentCodeSelectionList ( )
Returns
The list of names of all of the code items in the current code selection.

◆ GetCurrentDocument()

Document Document::GetCurrentDocument ( )

Gets the current document.

Returns
current document ( isNULL on returned value returns true if there is no current doc )
Deprecated:
Use Editor.GetCurrentDocument() instead.

◆ GetDerivedClass()

str Document::GetDerivedClass ( )

Gets the code generation tab 'Derived Class' setting.

Returns
derivedClass derived class name
Precondition
!isNULL()

◆ GetDirname()

str Document::GetDirname ( )

Gets the directory of this document without the filename.

Precondition
!isNULL()
Returns
The directory, or null if not set.

◆ GetDocumentByName()

Document Document::GetDocumentByName ( str  docName)

Gets the document with the given name, if open.

Returns
desired document ( isNULL on returned value returns true if there is no document with the given name open )
Deprecated:
Use Editor.GetDocumentByName() instead.

◆ GetDocumentCalculateCommentstr()

str Document::GetDocumentCalculateCommentstr ( )

Retrieves the comment for the Calculate method for a given document.

Returns
the Calculate method comment string
Exceptions
CEIException
Since
GL Studio 6.0.1

◆ GetDocumentCalculatestr()

str Document::GetDocumentCalculatestr ( )

Retrieves the body for the Calculate method for a given document.

Returns
the Calculate method body string
Exceptions
CEIException

◆ GetDocumentClassDeclarationstr()

str Document::GetDocumentClassDeclarationstr ( )

Retrieves the code class declaration for a given document.

Returns
the class declaration string
Exceptions
CEIException

◆ GetDocumentHeaderstr()

str Document::GetDocumentHeaderstr ( )

Retrieves the code header for a given document.

Returns
the header string
Exceptions
CEIException

◆ GetDocumentInfo()

DocumentInfo Document::GetDocumentInfo ( )

Gets the document info for this document.

Returns
the document info for this document
Precondition
!isNULL()

◆ GetDocumentInitializeCommentstr()

str Document::GetDocumentInitializeCommentstr ( )

Retrieves the comment for the Initialize method for a given document.

Returns
the Initialize method comment string
Exceptions
CEIException
Since
GL Studio 6.0.1

◆ GetDocumentInitializestr()

str Document::GetDocumentInitializestr ( )

Retrieves the body for the Initialize method for a given document.

Returns
the Initialize method body string
Exceptions
CEIException

◆ GetDocumentMainInitstr()

str Document::GetDocumentMainInitstr ( )

Retrieves the main init for a given document.

Returns
the main init string
Exceptions
CEIException

◆ GetDocumentMainLoopstr()

str Document::GetDocumentMainLoopstr ( )

Retrieves the main loop for a given document.

Returns
the main loop string
Exceptions
CEIException

◆ GetDocumentRootName()

str Document::GetDocumentRootName ( )

Retrieves the document's root name.

Returns
root name
Exceptions
CEIException
Precondition
!isNULL()

◆ GetDocumentSourcestr()

str Document::GetDocumentSourcestr ( )

Retrieves the code source for a given document.

Returns
the source string
Exceptions
CEIException

◆ GetEditorGenerationMode()

str Document::GetEditorGenerationMode ( )

Retrieves the current editor generation mode.

Returns
the generation mode
Exceptions
CEIException
Deprecated:
Use Editor.GetActiveCodeGenerator() instead.

◆ GetFilename()

str Document::GetFilename ( )

Gets the filename of this document without the directory.

Precondition
!isNULL()
Returns
The filename, or null if not set.

◆ GetFontPalette()

FontPalette Document::GetFontPalette ( )

Gets the font palette for this document.

Returns
the font palette for this document
Precondition
!isNULL()

◆ GetFrameBufferType()

FrameBufferType Document::GetFrameBufferType ( )

Gets the application tab 'frame buffer type' setting.

Returns
frame buffer type
Precondition
!isNULL()

◆ GetFrameRate()

int Document::GetFrameRate ( )

Gets the application tab 'frame rate' setting.

Returns
frame rate in hz
Precondition
!isNULL()

◆ GetGeometryFilterText()

str Document::GetGeometryFilterText ( )

Returns the current string held by the geometry browser filter.

Returns
string held by the geometry browser filter field.

◆ GetIdlDeclarationUserCode()

str Document::GetIdlDeclarationUserCode ( )

Get the IDL declaration user code.

Returns
the IDL declaration user code
Precondition
!isNULL()

◆ GetIdlFileUserCode()

str Document::GetIdlFileUserCode ( )

Get the IDL file user code.

Returns
the IDL file user code
Precondition
!isNULL()

◆ GetInitialEyePointName()

str Document::GetInitialEyePointName ( )

Gets the application tab 'inital eyepoint name' setting.

Returns
eye point name
Precondition
!isNULL()

◆ GetInitialHeight()

int Document::GetInitialHeight ( )

Gets the application tab 'initial height' setting.

Returns
initial height
Precondition
!isNULL()

◆ GetInitialPositionX()

int Document::GetInitialPositionX ( )

Gets the application tab 'initial position x' setting.

Returns
initial position x
Precondition
!isNULL()

◆ GetInitialPositionY()

int Document::GetInitialPositionY ( )

Gets the application tab 'initial position y' setting.

Returns
initial position y
Precondition
!isNULL()

◆ GetInitialWidth()

int Document::GetInitialWidth ( )

Gets the application tab 'initial width' setting.

Returns
initial width
Precondition
!isNULL()

◆ GetLastMouseDownPositionLogical()

Vector Document::GetLastMouseDownPositionLogical ( )
Returns
Vector representing the last mouse down position in the canvas, in logical coordinates.

◆ GetMaterial()

Material Document::GetMaterial ( int  materialIndex)

Retrieves a specific material for a given document.

Parameters
materialIndexindex of the desired material
Returns
the requested material
Exceptions
CEIException

◆ GetMaximumHeight()

int Document::GetMaximumHeight ( )

Gets the application tab 'maximum height' setting.

Returns
max height
Precondition
!isNULL()

◆ GetMaximumWidth()

int Document::GetMaximumWidth ( )

Gets the application tab 'maximum width' setting.

Returns
max width
Precondition
!isNULL()

◆ GetMethod()

Method Document::GetMethod ( int  methodIndex)

Retrieves a specific method for a given document.

Parameters
methodIndexindex of the desired method
Returns
the requested method
Exceptions
CEIException

◆ GetMinimumHeight()

int Document::GetMinimumHeight ( )

Gets the application tab 'minimum height' setting.

Returns
min height
Precondition
!isNULL()

◆ GetMinimumWidth()

int Document::GetMinimumWidth ( )

Gets the application tab 'minimum width' setting.

Returns
min width
Precondition
!isNULL()

◆ GetNumMaterials()

int Document::GetNumMaterials ( )

Retrieves the number of materials for a given document.

Returns
the number of materials
Exceptions
CEIException

◆ GetNumMethods()

int Document::GetNumMethods ( )

Retrieves the number of methods for a given document.

Returns
the number of methods
Exceptions
CEIException

◆ GetNumObjects()

int Document::GetNumObjects ( )

Gets the number of objects within a given document.

Returns
the number of objects within a given document
Exceptions
CEIException

◆ GetNumProperties()

int Document::GetNumProperties ( )

Retrieves the number of properties for a given document.

Returns
the number of properties
Exceptions
CEIException

◆ GetNumUserDefinedAttributes()

int Document::GetNumUserDefinedAttributes ( )

Gets the number of user defined attributes in the document.

Returns
int the number of user defined attributes in the document

◆ GetNumVariables()

int Document::GetNumVariables ( )

Retrieves the number of variables for a given document.

Returns
the number of variables
Exceptions
CEIException

◆ GetObjectByName()

DisplayObject * Document::GetObjectByName ( str  name)

Finds an object within a document.

Parameters
namestring containing the name of the object to find
Returns
the object, if it exists
Exceptions
CEIException

◆ GetObjectList()

Group * Document::GetObjectList ( )

Returns a group of all objects in the document hierarchy.

Returns
the group of objects
Exceptions
CEIException

◆ GetProjectionMode()

ProjectionMode Document::GetProjectionMode ( )

Gets the application tab 'projection mode' setting.

Returns
projection mode setting
Precondition
!isNULL()

◆ GetProperty()

Property Document::GetProperty ( int  propertyIndex)

Retrieves a specific property for a given document.

Parameters
propertyIndexindex of the desired property
Returns
the requested property
Exceptions
CEIException

◆ GetPropertyFilterText()

str Document::GetPropertyFilterText ( )

Returns the current string held by the object property table filter.

Returns
string held by the object property table filter field.

◆ GetRedrawMode()

RedrawMode Document::GetRedrawMode ( )

Gets the application tab 'redraw mode' setting.

Returns
redraw mode
Precondition
!isNULL()

◆ GetResources()

str Document::GetResources ( )

Gets all of the resources of all of the objects within this document.

◆ GetRuntimeAttributes()

RuntimeAttributesFlags Document::GetRuntimeAttributes ( )

Gets the resources tab 'runtime attributes' setting.

Returns
runtime attribute flags
Precondition
!isNULL()

◆ GetSelectedObjects()

DisplayObjectArray * Document::GetSelectedObjects ( )

Gets all selected objects in the document.

Returns
the array of selected objects
Precondition
!isNULL()

◆ GetSoundList()

SoundList Document::GetSoundList ( )

Gets the sound list for this document.

Returns
the sound list for this document
Precondition
!isNull()

◆ GetStandaloneHeaderFile()

str Document::GetStandaloneHeaderFile ( )

Gets the code generation tab 'standalone header file' setting.

Returns
standalone header file
Precondition
!isNULL()

◆ GetStandaloneInstanceName()

str Document::GetStandaloneInstanceName ( )

Gets the code generation tab 'standalone instance name' setting.

Returns
standalone instance name
Precondition
!isNULL()

◆ GetStandaloneMainFile()

str Document::GetStandaloneMainFile ( )

Get the code generation tab 'standalone main file' setting.

Returns
the code generation tab 'standalone main file' setting
Precondition
!isNULL()

◆ GetStandaloneSourceFile()

str Document::GetStandaloneSourceFile ( )

Gets the code generation tab 'standalone source file' setting.

Returns
standalone source file
Precondition
!isNULL()

◆ GetTexturePalette()

TexturePalette Document::GetTexturePalette ( )

Gets the texture palette for this document.

Returns
the texture palette for this document
Precondition
!isNULL()

◆ GetUserDefinedAttributeByGuid()

UserDefinedAttribute Document::GetUserDefinedAttributeByGuid ( str  guid)

Gets a user defined attribute within the document by guid.

Parameters
guidguid of the user defined attribute to retrieve
Returns
the user defined attribute with the given guid

◆ GetUserDefinedAttributeByIndex()

UserDefinedAttribute Document::GetUserDefinedAttributeByIndex ( int  index)

Gets a user defined attribute within the document by index.

Parameters
indexindex of the user defined attribute to retrieve
Returns
the user defined attribute with the given index

◆ GetUserDefinedBaseClass()

str Document::GetUserDefinedBaseClass ( )

Gets the user defined base class used in component code generation mode if user defined base class is enabled.

Returns
user defined base class else "" for no user defined base class
Precondition
!isNULL()

◆ GetUserDefinedBaseClassConstructorInit()

str Document::GetUserDefinedBaseClassConstructorInit ( )

Gets the code generation tab 'user defined base class ructor init' setting.

Returns
the code generation tab 'user defined base class ructor init' setting
Precondition
!isNULL()

◆ GetVariable()

Variable Document::GetVariable ( int  variableIndex)

Retrieves a specific variable for a given document.

Parameters
variableIndexindex of the desired variable
Returns
the requested variable
Exceptions
CEIException

◆ HasAccumulationBuffer()

bool Document::HasAccumulationBuffer ( )

Gets the application tab 'accumulation buffer' setting.

Returns
accumulation buffer setting
Precondition
!isNULL()

◆ HasAlphaInColorBuffer()

bool Document::HasAlphaInColorBuffer ( )

Gets the application tab 'alpha in color buffer' setting.

Returns
alpha in color buffer setting
Precondition
!isNULL()

◆ HasBorder()

bool Document::HasBorder ( )

Gets the application tab 'has border' setting.

Returns
has border setting
Precondition
!isNULL()

◆ HasDepthBuffer()

bool Document::HasDepthBuffer ( )

Gets the application tab 'depth buffer' setting.

Returns
depth buffer setting
Precondition
!isNULL()

◆ HasMultisampleBuffer()

bool Document::HasMultisampleBuffer ( )

Gets the application tab 'multisample buffer' setting.

Returns
multisample buffer setting
Precondition
!isNULL()

◆ HasStencilBuffer()

bool Document::HasStencilBuffer ( )

Gets the application tab 'stencil buffer' setting.

Returns
stencil buffer setting
Precondition
!isNULL()

◆ HasVisibleTab()

bool Document::HasVisibleTab ( )

Determines whether the given doc has a visible tab.

◆ HideTab()

None Document::HideTab ( )

Hides this document's tab, and shows the next open document.

If there are no other open documents, does nothing.

◆ InsertComponent() [1/2]

None Document::InsertComponent ( ComponentRef comp)

Adds a component to the document.

Parameters
comppointer to the component to be added to the document
Exceptions
CEIException

◆ InsertComponent() [2/2]

ComponentRef * Document::InsertComponent ( str  filename)

Adds a file as a component to the document.

Parameters
filenamestring containing the filename of the component to insert into the document
Returns
ComponentRef the newly added component
Exceptions
CEIException

◆ InsertObject()

None Document::InsertObject ( DisplayObject obj,
bool  renameName = false 
)

Inserts the given object to the document.

Parameters
objobject to insert
renameNameallows 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
Precondition
!isNULL()

◆ IsCodeGenerationFillInFromRoot()

bool Document::IsCodeGenerationFillInFromRoot ( )

Gets the code generation tab 'fill in from root' setting.

Returns
true if fill in from root is set
Precondition
!isNULL()

◆ isEqual()

bool Document::isEqual ( Document rhs)

Determines if wrapped document is equal to another wrapped document.

Parameters
rhsThe document to compare to this
Precondition
!isNULL() && !rhs.isNULL()
Returns
true if wrapped document's point to the same editor document

◆ IsFullScreen()

bool Document::IsFullScreen ( )

Gets the application tab 'full screen' setting.

Returns
full screen setting
Precondition
!isNULL()

◆ IsGenerateMainInSeparateFile()

bool Document::IsGenerateMainInSeparateFile ( )

Determines whether the main is generated in a separate file.

Returns
true if main is generated in a seperate file
Precondition
!isNULL()

◆ IsGenerateSourceComments()

bool Document::IsGenerateSourceComments ( )

Gets the code generation tab 'generate source comments' setting.

Returns
true if generate source comments is set
Precondition
!isNULL()

◆ isNULL()

bool Document::isNULL ( )

Determines if wrapped document does not exist.

Returns
True if this object represents a NULL document
Deprecated:
Refer to the Truth Value Checking page

◆ IsResizable()

bool Document::IsResizable ( )

Gets the application tab 'resizable' setting.

Returns
resizable setting
Precondition
!isNULL()

◆ IsUserDefinedBaseClassEnabled()

bool Document::IsUserDefinedBaseClassEnabled ( )

Determines if user defined base class is enabled.

Returns
true if enabled
Precondition
!isNULL()

◆ IsViewCulling()

bool Document::IsViewCulling ( )

Gets the application tab 'view culling' setting.

Returns
view culling setting
Precondition
!isNULL()

◆ LineColor() [1/2]

GlsColor Document::LineColor ( )

Gets the currently selected line color for the document.

Returns
line color of the Display Object

◆ LineColor() [2/2]

None Document::LineColor ( GlsColor  color)

Sets the document's current line color, and applies it to any selected objects.

Parameters
colorline color to be applied to the document

◆ LoadUserDefinedAttributes()

None Document::LoadUserDefinedAttributes ( str  filename)

Reads user defined attributes from a file.

Parameters
filenamename of the file from which the user defined attributes are to be read

◆ MakeCurrentDocument()

None Document::MakeCurrentDocument ( )

Makes this document the current document.

Precondition
!isNULL()
Exceptions
CEIException

◆ NewDocument()

Document Document::NewDocument ( str  fileName = "")

Creates a new document and makes it the current document.

Parameters
fileNameoptional filename to give the new document
Returns
a new document that is the current document
Deprecated:
Use Editor.NewDocument() instead.

◆ OpenDocument()

Document Document::OpenDocument ( str  fileName,
bool  showTab = true 
)

Opens a new document and makes it the current document.

Parameters
fileNamename of file to load
showTabwhether or not to show the file in a tab. If false, will open it in the background.
Returns
loaded document ( isNULL on returned value returns true if no doc loaded )
Deprecated:
Use Editor.OpenDocument() instead.

◆ PasteClipboardCodeItem()

None Document::PasteClipboardCodeItem ( )

Pastes the code item from the clipboard.

Exceptions
CEIException

◆ PasteClipboardObjects() [1/2]

None Document::PasteClipboardObjects ( bool  keepNames,
bool  keepPositions 
)

Pastes the objects from the clipboard.

Parameters
keepNamestrue to keep object names (deprecated and ignored)
keepPositionstrue to keep object positions
Exceptions
CEIException
Deprecated:
Use PasteClipboardObjects( bool keepPositions ) instead.

◆ PasteClipboardObjects() [2/2]

None Document::PasteClipboardObjects ( bool  keepPositions)

Pastes the objects from the clipboard.

Parameters
keepPositionstrue to keep object positions
Exceptions
CEIException
Since
GL Studio 6.0.1

◆ RedoAction()

None Document::RedoAction ( )

Redo the previously undone action.

Precondition
!isNULL()
Exceptions
CEIException

◆ Save()

None Document::Save ( )

Saves this document.

Precondition
!isNULL(), document has filename set
Exceptions
CEIException

◆ SaveAllDocuments()

None Document::SaveAllDocuments ( )

Saves all open documents.

Deprecated:
Use Editor.SaveAllDocuments() instead.

◆ SaveAs()

None Document::SaveAs ( str  fileName)

save this document with a given filename.

If no filename is specified, a popup will appear.

Exceptions
CEIException

◆ SaveUserDefinedAttributes()

None Document::SaveUserDefinedAttributes ( str  filename)

Writes user defined attributes to a file.

Parameters
filenamename of the file to which the user defined attributes are to be written

◆ SelectAll()

None Document::SelectAll ( )

Selects all of the objects within the document.

Precondition
!isNULL()

◆ SelectObject()

None Document::SelectObject ( DisplayObject obj)

Selects the object within the editor.

Parameters
objthe object to be selected
Precondition
!isNULL()

◆ SelectObjects() [1/2]

None Document::SelectObjects ( DisplayObjectArray objs)

Selects the objects within the editor, adding to current selection.

Parameters
objsthe object array to be selected
Precondition
!isNULL()

◆ SelectObjects() [2/2]

None Document::SelectObjects ( list  objectNames,
bool  addToCurrentSelection = false 
)

Selects the specified objects.

Parameters
objectNamesthe list object names.
addToCurrentSelectionif true, adds the specified objects to the pre-existing selection. If false, it clears the pre-existing selection before selecting the specified objects.

◆ SetAccumulationBuffer()

None Document::SetAccumulationBuffer ( bool  accumulationBuffer)

Sets the application tab 'accumulation buffer' setting.

Parameters
accumulationBufferaccumulation buffer setting
Precondition
!isNULL()

◆ SetAlphaInColorBuffer()

None Document::SetAlphaInColorBuffer ( bool  alphaInColorBuffer)

Sets the application tab 'alpha in color buffer' setting.

Parameters
alphaInColorBufferalpha in color buffer setting
Precondition
!isNULL()

◆ SetApplicationWindowTitle()

None Document::SetApplicationWindowTitle ( str  title)

Sets the application tab 'window title' setting.

Parameters
titlewindow title
Precondition
!isNULL()

◆ SetBackgroundColor() [1/2]

None Document::SetBackgroundColor ( GlsColor  color)

Sets the document's background color.

Parameters
colorthe color for the background

◆ SetBackgroundColor() [2/2]

None Document::SetBackgroundColor ( int  r,
int  g,
int  b,
int  a 
)

Sets the document's background color.

Parameters
rred color for the background
ggreen color for the background
bblue color for the background
aalpha color for the background

◆ SetCodeGenerationFillInFromRoot()

None Document::SetCodeGenerationFillInFromRoot ( bool  fillInFromRoot)

Sets the code generation tab 'fill in from root' setting.

Parameters
fillInFromRoottrue to fill in from root
Precondition
!isNULL()

◆ SetCodeGenerationMode()

None Document::SetCodeGenerationMode ( CodeGenerationMode  codeGenerationMode)

Sets the code generation mode.

Parameters
codeGenerationModecode generation mode
Precondition
!isNULL()

◆ SetCodeOutputPath()

None Document::SetCodeOutputPath ( str  codeOutputPath)

Sets the code generation code output path.

Parameters
codeOutputPaththe code generation code output path
Precondition
!isNULL()

◆ SetComponentHeaderFile()

None Document::SetComponentHeaderFile ( str  headerFile)

Sets the code generation tab 'component header file' setting.

Parameters
headerFilecomponent header file
Precondition
!isNULL(), !IsCodeGenerationFillInFromRoot()

◆ SetComponentSourceFile()

None Document::SetComponentSourceFile ( str  sourceFile)

Sets the code generation tab 'component source file' setting.

Parameters
sourceFilecomponent source file
Precondition
!isNULL(), !IsCodeGenerationFillInFromRoot()

◆ SetDepthBuffer()

None Document::SetDepthBuffer ( bool  depthBuffer)

Sets the application tab 'depth buffer' setting.

Parameters
depthBufferdepth buffer setting
Precondition
!isNULL()

◆ SetDerivedClass()

None Document::SetDerivedClass ( str  derivedClass)

Sets the code generation tab 'Derived Class' setting.

Parameters
derivedClassderived class name
Precondition
!isNULL(), !IsCodeGenerationFillInFromRoot()

◆ SetDirtyFlag()

None Document::SetDirtyFlag ( )

Mark this document as dirty.

Exceptions
CEIException

◆ SetDocumentCalculatestr()

None Document::SetDocumentCalculatestr ( str  str)

Sets the body for the Calculate method for a given document.

Parameters
strstr to be used in the body
Exceptions
CEIException

◆ SetDocumentClassDeclarationstr()

None Document::SetDocumentClassDeclarationstr ( str  str)

Sets the code class declaration for a given document.

Parameters
strstr to be added to the class declaration
Exceptions
CEIException

◆ SetDocumentHeaderstr()

None Document::SetDocumentHeaderstr ( str  str)

Sets the code header for a given document.

Parameters
strstr to be added at the beginning of the code header
Exceptions
CEIException

◆ SetDocumentInitializestr()

None Document::SetDocumentInitializestr ( str  str)

Sets the body for the Initialize method for a given document.

Parameters
strstr to be used in the body
Exceptions
CEIException

◆ SetDocumentMainInitstr()

None Document::SetDocumentMainInitstr ( str  str)

Sets the main init for a given document.

Parameters
strstr to be used in the main init
Exceptions
CEIException

◆ SetDocumentMainLoopstr()

None Document::SetDocumentMainLoopstr ( str  str)

Sets the main loop for a given document.

Parameters
strstr to be used in the main loop
Exceptions
CEIException

◆ SetDocumentRootName()

None Document::SetDocumentRootName ( str  rootName)

Sets the document's root name.

Exceptions
CEIException
Precondition
!isNULL()

◆ SetDocumentSaved()

None Document::SetDocumentSaved ( )

Clears the dirty flag without updating the document.

Precondition
!isNULL()
Exceptions
CEIException

◆ SetDocumentSourcestr()

None Document::SetDocumentSourcestr ( str  str)

Sets the code source for a given document.

Parameters
strstr to be added at the beginning of the code source
Exceptions
CEIException

◆ SetEditorGenerationMode()

None Document::SetEditorGenerationMode ( str  str)

Sets the current editor generation mode.

Parameters
strstr specifiying the new editor mode
Exceptions
CEIException
Deprecated:
Use Editor.SetActiveCodeGenerator() instead.

◆ SetFrameBufferType()

None Document::SetFrameBufferType ( FrameBufferType  frameBufferType)

Sets the application tab 'frame buffer type' setting.

Parameters
frameBufferTypeframe buffer type
Precondition
!isNULL()

◆ SetFrameRate()

None Document::SetFrameRate ( int  frameRateHz)

Sets the application tab 'frame rate' setting.

Parameters
frameRateHzframe rate in hz
Precondition
!isNULL()

◆ SetFullScreen()

None Document::SetFullScreen ( bool  fullScreen)

Sets the application tab 'full screen' setting.

Parameters
fullScreenfull screen setting
Precondition
!isNULL()

◆ SetGenerateMainInSeparateFile()

None Document::SetGenerateMainInSeparateFile ( bool  separateFile)

Sets whether the main is generated in a separate file.

Parameters
separateFiletrue to generate main in a seperate file
Precondition
!isNULL()

◆ SetGenerateSourceComments()

None Document::SetGenerateSourceComments ( bool  generateSourceComments)

Sets the code generation tab 'generate source comments' setting.

Parameters
generateSourceCommentstrue to generate source comments
Precondition
!isNULL()

◆ SetHasBorder()

None Document::SetHasBorder ( bool  hasBorder)

Sets the application tab 'has border' setting.

Parameters
hasBorderhas border setting
Precondition
!isNULL()

◆ SetIdlDeclarationUserCode()

None Document::SetIdlDeclarationUserCode ( str  idlDeclarationUserCode)

Set the IDL declaration user code.

Parameters
idlDeclarationUserCodethe IDL declaration user code
Precondition
!isNULL()

◆ SetIdlFileUserCode()

None Document::SetIdlFileUserCode ( str  idlFileUserCode)

Set the IDL file user code.

Parameters
idlFileUserCodethe IDL file user code
Precondition
!isNULL()

◆ SetInitialEyePointName()

None Document::SetInitialEyePointName ( str  eyePointName)

Sets the application tab 'inital eyepoint name' setting.

Parameters
eyePointNameeye point name
Precondition
!isNULL()

◆ SetInitialHeight()

None Document::SetInitialHeight ( int  height)

Sets the application tab 'initial height' setting.

Parameters
heightinitial height
Precondition
!isNULL()

◆ SetInitialPositionX()

None Document::SetInitialPositionX ( int  x)

Sets the application tab 'initial position x' setting.

Parameters
xinitial position x
Precondition
!isNULL()

◆ SetInitialPositionY()

None Document::SetInitialPositionY ( int  y)

Sets the application tab 'initial position y' setting.

Parameters
yinitial position y
Precondition
!isNULL()

◆ SetInitialWidth()

None Document::SetInitialWidth ( int  width)

Sets the application tab 'initial width' setting.

Parameters
widthinitial width
Precondition
!isNULL()

◆ SetMaximumHeight()

None Document::SetMaximumHeight ( int  height)

Sets the application tab 'maximum height' setting.

Parameters
heightmax height
Precondition
!isNULL()

◆ SetMaximumWidth()

None Document::SetMaximumWidth ( int  width)

Sets the application tab 'maximum width' setting.

Parameters
widthmax width
Precondition
!isNULL()

◆ SetMinimumHeight()

None Document::SetMinimumHeight ( int  height)

Sets the application tab 'minimum height' setting.

Parameters
heightmin height
Precondition
!isNULL()

◆ SetMinimumWidth()

None Document::SetMinimumWidth ( int  width)

Sets the application tab 'minimum width' setting.

Parameters
widthmin width
Precondition
!isNULL()

◆ SetMultisampleBuffer()

None Document::SetMultisampleBuffer ( bool  multisampleBuffer)

Sets the application tab 'multisample buffer' setting.

Parameters
multisampleBuffermultisample buffer setting
Precondition
!isNULL()

◆ SetProjectionMode()

None Document::SetProjectionMode ( ProjectionMode  projectionMode)

Sets the application tab 'projection mode' setting.

Parameters
projectionModeprojection mode
Precondition
!isNULL()

◆ SetRedrawMode()

None Document::SetRedrawMode ( RedrawMode  redrawMode)

Sets the application tab 'redraw mode' setting.

Parameters
redrawModeredraw mode
Precondition
!isNULL()

◆ SetResizable()

None Document::SetResizable ( bool  resizable)

Sets the application tab 'resizable' setting.

Parameters
resizableresizable setting
Precondition
!isNULL()

◆ SetRuntimeAttributes()

None Document::SetRuntimeAttributes ( RuntimeAttributesFlags  flags)

Sets the resources tab 'runtime attributes' setting.

Parameters
flagsruntime attribute flags
Precondition
!isNULL()

◆ SetStandaloneHeaderFile()

None Document::SetStandaloneHeaderFile ( str  headerFile)

Sets the code generation tab 'standalone header file' setting.

Parameters
headerFilestandalone header file
Precondition
!isNULL(), !IsCodeGenerationFillInFromRoot()

◆ SetStandaloneInstanceName()

None Document::SetStandaloneInstanceName ( str  instanceName)

Sets the code generation tab 'standalone instance name' setting.

Parameters
instanceNamestandalone instance name
Precondition
!isNULL(), !IsCodeGenerationFillInFromRoot()

◆ SetStandaloneMainFile()

None Document::SetStandaloneMainFile ( str  mainFile)

Set the code generation tab 'standalone main file' setting.

Parameters
mainFilemain file
Precondition
!isNULL()

◆ SetStandaloneSourceFile()

None Document::SetStandaloneSourceFile ( str  sourceFile)

Sets the code generation tab 'standalone source file' setting.

Parameters
sourceFilestandalone source file
Precondition
!isNULL(), !IsCodeGenerationFillInFromRoot()

◆ SetStencilBuffer()

None Document::SetStencilBuffer ( bool  stencilBuffer)

Sets the application tab 'stencil buffer' setting.

Parameters
stencilBufferstencil buffer setting
Precondition
!isNULL()

◆ SetUserDefinedBaseClass()

None Document::SetUserDefinedBaseClass ( str  userDefinedBaseClass)

Sets the user defined base class used in component code generation mode if user defined base class is enabled.

Parameters
userDefinedBaseClassuser defined base class
Precondition
!isNULL()

◆ SetUserDefinedBaseClassConstructorInit()

None Document::SetUserDefinedBaseClassConstructorInit ( str  ctorInit)

Sets the code generation tab 'user defined base class ructor init' setting.

Parameters
ctorInitthe code generation tab 'user defined base class ructor init' setting
Precondition
!isNULL()

◆ SetViewCulling()

None Document::SetViewCulling ( bool  viewCulling)

Sets the application tab 'view culling' setting.

Parameters
viewCullingview culling setting
Precondition
!isNULL()

◆ UndoAction()

None Document::UndoAction ( )

Undo the previous action.

Precondition
!isNULL()
Exceptions
CEIException

◆ UnselectObject()

None Document::UnselectObject ( DisplayObject obj)

Unselects the object within the editor.

Parameters
objthe object to be unselected
Precondition
!isNULL()

◆ UnselectObjects()

None Document::UnselectObjects ( DisplayObjectArray objs)

Unselects the objects within the editor.

Parameters
objsthe object array to be unselected
Precondition
!isNULL()

◆ UpdateMaterial()

None Document::UpdateMaterial ( int  materialIndex,
Material  matUpdates 
)

Updates a specific material for a given document.

Parameters
materialIndexindex of the material to be updated
matUpdatesmaterial containing the updated material information
Exceptions
CEIException

◆ UpdateUserDefinedAttribute()

None Document::UpdateUserDefinedAttribute ( UserDefinedAttribute  attrib)

Updates a user defined attribute within the document.

Parameters
attribthe user defined attribute to be updated

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