Python Script Engine  1.0
GL Studio Editor Python Script API
GlsASEImporter Class Reference

Public Member Functions

GroupImport (String filename, Document doc, bool reposition, bool enableLighting, bool splitAnims, bool ignoreFileNormals, float scale, bool executeScript, String scriptFilePath, bool useAdvancedMesh=false, bool useVertexColors=true)
 
void Import (String filename, Group *grp, bool reposition, bool enableLighting, bool splitAnims, bool ignoreFileNormals, float scale, bool executeScript, String scriptFilePath, bool useAdvancedMesh=false, bool useVertexColors=true)
 

Static Public Member Functions

static GlsASEImporterGetInstance (void)
 

Detailed Description

Plug-in used to import ASE files into GL Studio.

Member Function Documentation

static GlsASEImporter& GlsASEImporter::GetInstance ( void  )
static
Group* GlsASEImporter::Import ( String  filename,
Document  doc,
bool  reposition,
bool  enableLighting,
bool  splitAnims,
bool  ignoreFileNormals,
float  scale,
bool  executeScript,
String  scriptFilePath,
bool  useAdvancedMesh = false,
bool  useVertexColors = true 
)

Imports an ASE file using the ASE importer.

Parameters
filenameName of the file to import (supports .ASE and .DSI files)
docDocument into which the file should be imported
repositionIf true, the imported objects' bottom left corner will appear at the origin (0,0) in the canvas. Otherwise, their center will appear at the origin.
enableLightingSets the value of the "Enable lighting" property on all imported objects.
splitAnimsSeparates imported animations into position, rotation, and scaling pieces. An animation becomes a GlsDynamicPath in GL Studio.
ignoreFileNormalsIgnore the normals coming from the file and recalculate the mesh normals using face smoothing groups.
scaleScale to be applied to the newly imported objects. If the value is 1, it comes in at the scale in the file. If greater than 1, it comes in bigger in all dimensions. If between 0 and 1, it comes in smaller. Scaling is done relative to the origin of the canvas (0,0,0).
executeScriptFlag if a script should be executed upon import (deprecated)
scriptFilePathName of the script file to be executed upon import (deprecated)
useAdvancedMeshIf true, imported geometry will be in the form of GlsAdvancedMesh, otherwise GlsTrimesh.
useVertexColorsIf checked, per-vertex colors are assigned to the mesh’s vertices. If not, the vertices default to white and rely on the material settings to apply the color.
Returns
A group containing objects imported from the ASE file
Exceptions
CEIException
void GlsASEImporter::Import ( String  filename,
Group grp,
bool  reposition,
bool  enableLighting,
bool  splitAnims,
bool  ignoreFileNormals,
float  scale,
bool  executeScript,
String  scriptFilePath,
bool  useAdvancedMesh = false,
bool  useVertexColors = true 
)

Imports an ASE file using the ASE importer.

Note
new group is not automatically added to the document
Precondition
Parent document of group is not null
Parameters
filenameName of the file to import (supports .ASE and .DSI files)
[in,out]grpThe group to insert the imported geometry into. Must already be in a Document.
repositionIf true, the imported objects' bottom left corner will appear at the origin (0,0) in the canvas. Otherwise, their center will appear at the origin.
enableLightingSets the value of the "Enable lighting" property on all imported objects.
splitAnimsSeparates imported animations into position, rotation, and scaling pieces. An animation becomes a GlsDynamicPath in GL Studio.
ignoreFileNormalsIgnore the normals coming from the file and recalculate the mesh normals using face smoothing groups.
scaleScale to be applied to the newly imported objects. If the value is 1, it comes in at the scale in the file. If greater than 1, it comes in bigger in all dimensions. If between 0 and 1, it comes in smaller. Scaling is done relative to the origin of the canvas (0,0,0).
executeScriptFlag if a script should be executed upon import (deprecated)
scriptFilePathName of the script file to be executed upon import (deprecated)
useAdvancedMeshIf true, imported geometry will be in the form of GlsAdvancedMesh, otherwise GlsTrimesh.
useVertexColorsIf checked, per-vertex colors are assigned to the mesh’s vertices. If not, the vertices default to white and rely on the material settings to apply the color.
Exceptions
CEIException

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