GlsAdvancedMesh Class Reference

Inheritance diagram for GlsAdvancedMesh:

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

Static Public Member Functions
static DisplayObject *	ConvertGroupToAdvancedMesh (Group *group)
static GlsAdvancedMesh *	CastToGlsAdvancedMesh (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() [1/3]

GlsAdvancedMesh::GlsAdvancedMesh

(

)

GlsAdvancedMesh() [2/3]

GlsAdvancedMesh::GlsAdvancedMesh

(

GlsAdvancedMesh &

src

)

GlsAdvancedMesh() [3/3]

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

ctor

Parameters

advancedMesh	GlsAdvancedMesh to wrap
incEditorRef	true if to increment editor ref on with wrapped group (i.e. if this pointer came from the editor) else false

Member Function Documentation

CastToGlsAdvancedMesh()

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

obj	objects to cast

Returns

GlsAdvancedMesh The object as an Advanced Mesh

Exceptions

CEIException

ConvertGroupToAdvancedMesh()

static DisplayObject * GlsAdvancedMesh::ConvertGroupToAdvancedMesh ( Group *  group )

static

GetGeometryResource()

GlsGeometryResource * GlsAdvancedMesh::GetGeometryResource

(

)

Accessor for the GlsGeometryResource for this mesh.

Returns

a pointer to the Geometry Resource

Precondition

_geometryResource must be allocated

GetIndexBufferEffect()

GlsRenderEffect * GlsAdvancedMesh::GetIndexBufferEffect

(

int

bufferNum

)

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

Parameters

bufferNum

The 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

NumIndexBufferEffects()

int GlsAdvancedMesh::NumIndexBufferEffects

(

)

Returns

The size of the IndexBufferEffects array

NumIndexBuffers()

int GlsAdvancedMesh::NumIndexBuffers

(

)

Returns

The number of IndexBuffers in the current render mesh

ReorderAtWill() [1/2]

bool GlsAdvancedMesh::ReorderAtWill

(

)

Returns

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

ReorderAtWill() [2/2]

None GlsAdvancedMesh::ReorderAtWill

(

bool

reorderAtWill

)

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

ResizeIndexBufferEffectsArray()

None GlsAdvancedMesh::ResizeIndexBufferEffectsArray

(

int

newSize

)

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

SetGeometryResource()

None 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

value

a valid GeometryResource object

SetIndexBufferEffect()

None GlsAdvancedMesh::SetIndexBufferEffect	(	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

bufferNum	The IndexBuffer to get the effect for. Should be between 0 and NumIndexBuffers().
newEffect	The render effect to apply to this mesh.

---

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

• GlsAdvancedMesh.i