TalanSoft Toolkits  201707
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | List of all members
iDrawOperation Struct Referenceabstract
Inheritance diagram for iDrawOperation:
iUnknown

Detailed Description

Draw operation interface.

Public Member Functions

virtual tBool Copy (const iDrawOperation *apDO)=0
 Copy another draw operation. More...
 
virtual iDrawOperationClone () const =0
 Clone this draw operation. More...
 
virtual tBool GetIsCompiled () const =0
 Return whether the draw operation is compiled (read-only) {Property}. More...
 
virtual void SetPriority (tU32 anPriority)=0
 Set the priority. {Property}. More...
 
virtual tU32 GetPriority () const =0
 Get the priority. {Property}. More...
 
virtual void SetVertexArray (iVertexArray *apVertexArray)=0
 Set the vertex array. {Property}. More...
 
virtual iVertexArrayGetVertexArray () const =0
 Get the vertex array. {Property}. More...
 
virtual void SetPrimitiveType (eGraphicsPrimitiveType aPrim)=0
 Set the primitive type. More...
 
virtual eGraphicsPrimitiveType GetPrimitiveType () const =0
 Get the primitive type. {Property}. More...
 
virtual void SetIndexArray (iIndexArray *apIndexArray)=0
 Set the index array. {Property}. More...
 
virtual iIndexArrayGetIndexArray () const =0
 Get the index array. {Property}. More...
 
virtual void SetFirstIndex (tU32 anIndex)=0
 Set the first index. {Property}. More...
 
virtual tU32 GetFirstIndex () const =0
 Get the first index. {Property}. More...
 
virtual void SetNumIndices (tU32 anNumIndices)=0
 Set the number of indices. {Property}. More...
 
virtual tU32 GetNumIndices () const =0
 Get the number of indices. {Property}. More...
 
virtual void SetBaseVertexIndex (tU32 anBaseVertexIndex)=0
 Set the base vertex index. {Property}. More...
 
virtual tU32 GetBaseVertexIndex () const =0
 Get the base vertex index. {Property}. More...
 
virtual void SetMatrix (const sMatrixf &apMatrix)=0
 Set the matrix. {Property}. More...
 
virtual sMatrixf GetMatrix () const =0
 Get the matrix. {Property}. More...
 
virtual void SetMaterial (iMaterial *apMaterial)=0
 Set the material. {Property}. More...
 
virtual iMaterialGetMaterial () const =0
 Get the material. {Property}. More...
 
virtual void SetLocalBoundingVolume (iBoundingVolume *apBV)=0
 Set the bounding volume. {Property}. More...
 
virtual iBoundingVolumeGetLocalBoundingVolume () const =0
 Get the bounding volume in local space. {Property}. More...
 
virtual iBoundingVolumeGetBoundingVolume () const =0
 Get the bounding volume in world space. {Property}. More...
 
virtual sVec3f GetCenter () const =0
 Get the center position. {Property}. More...
 
virtual tFVF GetFVF () const =0
 Get the FVF of the draw operation. {Property}. More...
 
- Public Member Functions inherited from iUnknown
virtual tBool IsOK () const =0
 Check if the object is valid. More...
 
virtual tI32 AddRef ()=0
 Signal that one more reference of the object has been created. More...
 
virtual tI32 Release ()=0
 Release a reference of the object. More...
 
virtual void DeleteThis ()=0
 Bypass any reference counting and delete this object. More...
 
virtual void Invalidate ()=0
 Invalidate the object. More...
 
virtual iUnknownQueryInterface (const tUUID &aIID)=0
 Query an interface. More...
 
virtual void ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
 Fill a UUID list containing the UUIDs of the implemented interfaces. More...
 
virtual tI32 SetNumRefs (tI32 anNumRefs)=0
 Set the reference counter directly. More...
 
virtual tI32 GetNumRefs () const =0
 Get the number of references to this object. More...
 

Member Function Documentation

virtual tBool Copy ( const iDrawOperation apDO)
pure virtual

Copy another draw operation.

virtual iDrawOperation* Clone ( ) const
pure virtual

Clone this draw operation.

virtual tBool GetIsCompiled ( ) const
pure virtual

Return whether the draw operation is compiled (read-only) {Property}.

virtual void SetPriority ( tU32  anPriority)
pure virtual

Set the priority. {Property}.

virtual tU32 GetPriority ( ) const
pure virtual

Get the priority. {Property}.

virtual void SetVertexArray ( iVertexArray apVertexArray)
pure virtual

Set the vertex array. {Property}.

virtual iVertexArray* GetVertexArray ( ) const
pure virtual

Get the vertex array. {Property}.

virtual void SetPrimitiveType ( eGraphicsPrimitiveType  aPrim)
pure virtual

Set the primitive type.

Remarks
The primtive type is relevant only if no index array has been set.
If an index array is set the primitive type is read only, tying to set it will have no effect. The primitive type returned will be the one of the index array. {Property}
virtual eGraphicsPrimitiveType GetPrimitiveType ( ) const
pure virtual

Get the primitive type. {Property}.

virtual void SetIndexArray ( iIndexArray apIndexArray)
pure virtual

Set the index array. {Property}.

virtual iIndexArray* GetIndexArray ( ) const
pure virtual

Get the index array. {Property}.

virtual void SetFirstIndex ( tU32  anIndex)
pure virtual

Set the first index. {Property}.

virtual tU32 GetFirstIndex ( ) const
pure virtual

Get the first index. {Property}.

virtual void SetNumIndices ( tU32  anNumIndices)
pure virtual

Set the number of indices. {Property}.

virtual tU32 GetNumIndices ( ) const
pure virtual

Get the number of indices. {Property}.

virtual void SetBaseVertexIndex ( tU32  anBaseVertexIndex)
pure virtual

Set the base vertex index. {Property}.

virtual tU32 GetBaseVertexIndex ( ) const
pure virtual

Get the base vertex index. {Property}.

virtual void SetMatrix ( const sMatrixf apMatrix)
pure virtual

Set the matrix. {Property}.

virtual sMatrixf GetMatrix ( ) const
pure virtual

Get the matrix. {Property}.

virtual void SetMaterial ( iMaterial apMaterial)
pure virtual

Set the material. {Property}.

virtual iMaterial* GetMaterial ( ) const
pure virtual

Get the material. {Property}.

virtual void SetLocalBoundingVolume ( iBoundingVolume apBV)
pure virtual

Set the bounding volume. {Property}.

virtual iBoundingVolume* GetLocalBoundingVolume ( ) const
pure virtual

Get the bounding volume in local space. {Property}.

virtual iBoundingVolume* GetBoundingVolume ( ) const
pure virtual

Get the bounding volume in world space. {Property}.

virtual sVec3f GetCenter ( ) const
pure virtual

Get the center position. {Property}.

Remarks
The center position is the center of the bouding volume multiplied by the matrix.
virtual tFVF GetFVF ( ) const
pure virtual

Get the FVF of the draw operation. {Property}.

Remarks
Try to get the FVF from the material, if zero the FVF of the vertex array is returned.