Python Script Engine  8.1
GL Studio Editor Python Script API
GlsAdvancedMesh Class Reference
+ Inheritance diagram for GlsAdvancedMesh:

Public Member Functions

 GlsAdvancedMesh ()
 
 GlsAdvancedMesh (GlsAdvancedMesh &src)
 
 GlsAdvancedMesh (disti::GlsAdvancedMesh *advancedMesh, bool incEditorRef)
 
void SetGeometryResource (GlsGeometryResource *value)
 
GlsGeometryResourceGetGeometryResource ()
 
unsigned int NumIndexBuffers ()
 
unsigned int NumIndexBufferEffects ()
 
bool ReorderAtWill ()
 
void ReorderAtWill (bool reorderAtWill)
 
void ResizeIndexBufferEffectsArray (unsigned int newSize)
 
GlsRenderEffectGetIndexBufferEffect (unsigned int bufferNum)
 
void SetIndexBufferEffect (unsigned int bufferNum, GlsRenderEffect *newEffect)
 
- Public Member Functions inherited from DisplayObject
bool isNULL (void)
 
String GetName ()
 
String SetName (String name)
 
void SetProtectionMode (DisplayObject::MemberAccess_e mode)
 
DisplayObject::MemberAccess_e GetProtectionMode (void)
 
void SetLocked (bool val)
 
bool GetLocked (void)
 
bool GetGenerateMemberVariable ()
 
void SetGenerateMemberVariable (bool b)
 
bool GetAntiAliasing ()
 
void SetAntiAliasing (bool antiAliasing)
 
bool GetBlinking ()
 
void SetBlinking (bool blinking)
 
float GetBlinkRate ()
 
void SetBlinkRate (float rate)
 
int GetAlphaMode ()
 
void SetAlphaMode (int mode)
 
bool GetCullBackFaces ()
 
void SetCullBackFaces (bool cullFaces)
 
bool GetZBufferTestedFlag ()
 
void SetZBufferTestedFlag (bool tested)
 
bool GetAffectZBufferFlag ()
 
void SetAffectZBufferFlag (bool affect)
 
bool GetLightingEnabledFlag ()
 
void SetLightingEnabledFlag (bool enabled)
 
DisplayObject::PickableType_e GetPickMode ()
 
void SetPickMode (DisplayObject::PickableType_e mode)
 
bool GetVisibilityFlag ()
 
void SetVisibilityFlag (bool visible)
 
PolygonClose_e GetClosePolygonFlag ()
 
void SetClosePolygonFlag (PolygonClose_e closePolygon)
 
PolygonMode_e GetPolygonMode ()
 
void SetPolygonMode (PolygonMode_e polygonMode)
 
ShadingType_e GetShadingMode ()
 
void SetShadingMode (ShadingType_e shadingMode)
 
Vertex GetLocation ()
 
void SetLocation (Vertex loc)
 
Vertex GetRotationPoint ()
 
void SetRotationPoint (Vertex rotPoint)
 
GlsMatrixAffineGetDcsMatrix ()
 
void SetDcsMatrix (GlsMatrixAffine *matrix)
 
int GetMaterialIndex ()
 
void SetMaterialIndex (int matIndex)
 
String GetObjectClassName ()
 
int GetTextureIndex ()
 
void SetTextureIndex (int texIndex)
 
TextureMap_e GetTextureMappingTechnique ()
 
void SetTextureMappingTechnique (TextureMap_e mappingTechnique)
 
bool GetTextureRepeat ()
 
void SetTextureRepeat (bool repeat)
 
disti::GlsColor GetBlendingColor ()
 
void SetBlendingColor (GlsColor blendColor)
 
DisplayObject::TextureFilter_e GetTextureMagnificationFilter ()
 
void SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)
 
DisplayObject::TextureFilter_e GetTextureMinificationFilter ()
 
void SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)
 
std::vector< VectorGetTextureCoordinates ()
 
void SetTextureCoordinates (std::vector< Vector > &texVerts)
 
void GetTextureCoordinates (VertexArray *texVerts)
 
void SetTextureCoordinates (VertexArray &texVerts)
 
void GetTexturePoints (VertexArray *texVerts)
 
void SetTexturePoints (VertexArray &texVerts)
 
void SetTexturePoints (std::vector< Vector > &texVerts)
 
std::vector< VectorGetTexturePoints ()
 
void GetVertices (VertexArray *verts)
 
void SetVertices (VertexArray &verts)
 
String GetInitialization ()
 
void SetInitialization (String initCode)
 
String GetCallbackCode ()
 
void SetCallbackCode (String cbCode)
 
DisplayObjectDuplicateObject (Document *doc=NULL)
 
DisplayObjectTessellateObject ()
 
DisplayObjectExtrudeObject (float amount)
 
void RotateObject (float amount, RotationAxis_e axis)
 
void TranslateObject (float x, float y, float z)
 
void ScaleObject (float x, float y, float z, Vertex *anchor=NULL)
 
void LineWidth (float width)
 
float LineWidth ()
 
LineStyle_e LineStyle ()
 
void LineStyle (LineStyle_e style)
 
GlsColor LineColor ()
 
void LineColor (GlsColor color)
 
GlsColor FillColor ()
 
void FillColor (GlsColor color)
 
void GetExtents (Vector &min, Vector &max)
 
bool HasUserDefinedAttribute (String attribName)
 
std::map< String, String > GetUserDefinedAttributes ()
 
UserDefinedValueAttributeList GetAllUserDefinedAttributes ()
 
String GetUserDefinedAttributeValue (String attribName)
 
 typemap (check) String attribName
 
void SetUserDefinedAttributeValue (String attribName, String value)
 
DisplayObjectGetParent ()
 
DocumentGetDocument ()
 
String AlternateClassName ()
 
void AlternateClassName (String name)
 
String GetAlternateClassHeaderFile ()
 
void SetAlternateClassHeaderFile (String name)
 
String GetResources ()
 
String GetRuntimeResources (bool recursive)
 
String GetAttributeValueString (String attribName)
 
void SetAttributeValueString (String attribName, String value)
 
unsigned int RegisterObserver (String attribName, PyObject *pyfunc)
 
void UnregisterObserver (String attribName, unsigned int id)
 
std::vector< VectorGetNormals ()
 
void SetNormals (std::vector< Vector > &normals)
 
std::vector< CustomAttributeInfoGetExtraAttributes ()
 
DisplayObjectCloneObject ()
 
void CopyProperties (DisplayObject *sourceObj)
 
void SetLocation (Vector loc)
 
GlsMatrixAffine GetObjectCoordinatesTransform (DisplayObject *targetObject)
 
void CalculateParentBoundingBox ()
 
void SetOrigin (Vertex &vert)
 

Static Public Member Functions

static DisplayObjectConvertGroupToAdvancedMesh (Group *group)
 
static GlsAdvancedMeshCastToGlsAdvancedMesh (DisplayObject *obj)
 

Additional Inherited Members

- Public Types inherited from DisplayObject
enum  MemberAccess_e {
  PUBLIC,
  PRIVATE,
  PROTECTED
}
 
enum  PickableType_e {
  UNPICKABLE,
  FIRST_PICK,
  BEST_PICK,
  ALWAYS_PICK
}
 
enum  PolygonClose_e {
  POLY_OPEN,
  POLY_CLOSED
}
 
enum  PolygonMode_e {
  POLY_MODE_UNDEFINED,
  POLY_MODE_POINTS,
  POLY_MODE_OUTLINE,
  POLY_MODE_FILLED,
  POLY_MODE_FILL_AND_OUTLINE
}
 
enum  ShadingType_e {
  SHADING_FLAT,
  SHADING_GOURAUD
}
 
enum  TextureMap_e {
  TEXTURE_MAP_MODULATE,
  TEXTURE_MAP_DECAL,
  TEXTURE_MAP_BLEND,
  TEXTURE_MAP_REPLACE
}
 
enum  TextureFilter_e {
  TEXTURE_FILTER_NEAREST,
  TEXTURE_FILTER_LINEAR,
  TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST,
  TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR,
  TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR,
  TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST
}
 
enum  TessellateType_e {
  TESSELLATE_UNION,
  TESSELLATE_INTERSECT,
  TESSELLATE_DIFFERENCE
}
 
enum  RotationAxis_e {
  X_AXIS,
  Y_AXIS,
  Z_AXIS
}
 
enum  LineStyle_e {
  SOLID_LINE_STYLE,
  SMALL_DOTTED_LINE_STYLE,
  DOTTED_LINE_STYLE,
  DASHED_LINE_STYLE,
  DOT_DASHED_LINE_STYLE,
  SMALL_DASHED_LINE_STYLE
}
 
enum  AlphaMode_e {
  ALPHA_MODE_UNDEFINED,
  ALPHA_MODE_OPAQUE,
  ALPHA_MODE_2_LEVEL,
  ALPHA_MODE_256_LEVEL
}
 
- Static Public Attributes inherited from DisplayObject
static int TEXTURE_INDEX_NONE = -1
 

Detailed Description

Python engine extension for the TexturePaletteEntry editor object.

Constructor & Destructor Documentation

GlsAdvancedMesh::GlsAdvancedMesh ( )
GlsAdvancedMesh::GlsAdvancedMesh ( GlsAdvancedMesh src)
GlsAdvancedMesh::GlsAdvancedMesh ( disti::GlsAdvancedMesh *  advancedMesh,
bool  incEditorRef 
)

ctor

Parameters
advancedMeshGlsAdvancedMesh to wrap
incEditorReftrue if to increment editor ref on with wrapped group (i.e. if this pointer came from the editor) else false

Member Function Documentation

static GlsAdvancedMesh* GlsAdvancedMesh::CastToGlsAdvancedMesh ( DisplayObject obj)
static

Casts the Display Object as a GlsAdvancedMesh NOTE: perform an isNULL check on the returned value to ensure the cast was accomplished.

Parameters
objobjects to cast
Returns
GlsAdvancedMesh The object as an Advanced Mesh
Exceptions
CEIException
static DisplayObject* GlsAdvancedMesh::ConvertGroupToAdvancedMesh ( Group group)
static
GlsGeometryResource* GlsAdvancedMesh::GetGeometryResource ( )

Accessor for the GlsGeometryResource for this mesh.

Returns
a pointer to the Geometry Resource
Precondition
_geometryResource must be allocated
GlsRenderEffect* GlsAdvancedMesh::GetIndexBufferEffect ( unsigned int  bufferNum)

Access the GlsRenderEffect that is used to render the specified index buffer (may be NULL)

Parameters
bufferNumThe IndexBuffer to get the effect for. Must be between 0 and NumIndexBuffers().
Returns
Pointer to the index buffer effect used when rendering the specified GlsGeometryResource IndexBuffer
unsigned int GlsAdvancedMesh::NumIndexBufferEffects ( )
Returns
The size of the IndexBufferEffects array
unsigned int GlsAdvancedMesh::NumIndexBuffers ( )
Returns
The number of IndexBuffers in the current render mesh
bool GlsAdvancedMesh::ReorderAtWill ( )
Returns
The whether or not the draw order of the mesh can be modified for performance
void GlsAdvancedMesh::ReorderAtWill ( bool  reorderAtWill)

Sets whether or not the draw order of the mesh can be modified for performance.

void GlsAdvancedMesh::ResizeIndexBufferEffectsArray ( unsigned int  newSize)

Set the size of the IndexBufferEffects array This will release any effects that are no longer referenced.

void GlsAdvancedMesh::SetGeometryResource ( GlsGeometryResource value)

Grab a pointer to the Resource.

We do not copy the resource, we now have at least two AdvancedMeshs that have interest in the same Geometry.

Parameters
valuea valid GeometryResource object
void GlsAdvancedMesh::SetIndexBufferEffect ( unsigned int  bufferNum,
GlsRenderEffect newEffect 
)

Set the GlsRenderEffect to use when rendering the given index buffer.

If this value is NULL, the geometry will be rendered with a default effect. Note: the GlsGeometryResourceMesh will increment the reference count on the new effect and release any effect that was previously referenced.

Parameters
bufferNumThe IndexBuffer to get the effect for. Should be between 0 and NumIndexBuffers().
newEffectThe render effect to apply to this mesh.
Returns
Pointer to the index buffer effect to use when rendering the specified GlsGeometryResource IndexBuffer

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