CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGiMapperItem Class Referenceabstract

#include <GiMapperItem.h>

Inheritance diagram for OdGiMapperItem:
OdRxObject OdGiMapperRenderItem

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiMapperItem)
 
virtual void setDiffuseMapper (const OdGiMaterialTraitsData &traitsData)=0
 
virtual void setDiffuseMapper (const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm)=0
 
virtual void setDiffuseMapper (const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData)=0
 
virtual void setDiffuseMapper (const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm)=0
 
virtual OdGiMapperItemEntryPtr diffuseMapper () const =0
 
virtual OdGiMapperItemEntryPtr diffuseMapper ()=0
 
virtual void setMapper (const OdGiMaterialTraitsData &traitsData, const OdDbStub *pMaterial=NULL)=0
 
virtual void setMapper (const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm, const OdDbStub *pMaterial=NULL)=0
 
virtual void setMapper (const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdDbStub *pMaterial=NULL)=0
 
virtual void setMapper (const OdGiMapper *pMapper, const OdGiMaterialTraitsData &traitsData, const OdGeMatrix3d &tm, const OdDbStub *pMaterial=NULL)=0
 
virtual void setModelTransform (const OdGeMatrix3d &mtm, bool recomputeTransforms=true)=0
 
virtual void setObjectTransform (const OdGeMatrix3d &otm, bool recomputeTransforms=true)=0
 
virtual void setObjectTransform (OdInt32 nCount, const OdGePoint3d *pPoints, bool recomputeTransforms=true)=0
 
virtual void setObjectTransform (const OdGeExtents3d &exts, bool recomputeTransforms=true)=0
 
virtual void setDeviceTransform (const OdGeMatrix3d &dtm, bool recomputeTransforms=true)=0
 
virtual bool isLastProcValid (const OdDbStub *pMaterial)=0
 
virtual bool isLastProcValid (const OdDbStub *pMaterial, const OdGeMatrix3d &tm)=0
 
virtual bool isLastProcValid (const OdGiMapper *pMapper, const OdDbStub *pMaterial)=0
 
virtual bool isLastProcValid (const OdGiMapper *pMapper, const OdDbStub *pMaterial, const OdGeMatrix3d &tm)=0
 
virtual bool isLastProcValid (const OdGeMatrix3d &tm)=0
 
virtual bool isEntityMapper () const =0
 
virtual bool isObjectMatrixNeed () const =0
 
virtual bool isModelMatrixNeed () const =0
 
virtual bool isDependsFromObjectMatrix () const =0
 
virtual bool isVertexTransformRequired () const =0
 
virtual void setVertexTransform (OdInt32 nCount, const OdGePoint3d *pPoints)=0
 
virtual void setVertexTransform (const OdGeExtents3d &exts)=0
 
virtual void setInputTransform (const OdGeMatrix3d &tm, bool bVertexDependantOnly=true)=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

Container item for material data storage. OdGiMapperItem used for real-time devices, such as DirectX or OpenGL.

See also
TD_Gi

<group OdGi_Classes>

Definition at line 342 of file GiMapperItem.h.

Member Function Documentation

◆ diffuseMapper() [1/2]

virtual OdGiMapperItemEntryPtr OdGiMapperItem::diffuseMapper ( ) const
pure virtual

Retrieves a smart pointer to a diffuse mapper object.

Returns
mapper for diffuse texture channel.

Implemented in OdGiMapperRenderItem.

◆ diffuseMapper() [2/2]

virtual OdGiMapperItemEntryPtr OdGiMapperItem::diffuseMapper ( )
pure virtual

Retrieves a smart pointer to a diffuse mapper object.

Returns
mapper for diffuse texture channel.

Implemented in OdGiMapperRenderItem.

◆ isDependsFromObjectMatrix()

virtual bool OdGiMapperItem::isDependsFromObjectMatrix ( ) const
pure virtual

Checks whether this mapper item requires a model transform.

Returns
true if mapper requires object or vertex transform, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isEntityMapper()

virtual bool OdGiMapperItem::isEntityMapper ( ) const
pure virtual

Checks whether entity mapper is specified for this mapper.

Returns
true if entity mapper is specified, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isLastProcValid() [1/5]

virtual bool OdGiMapperItem::isLastProcValid ( const OdDbStub *  pMaterial)
pure virtual

Checks whether the current material is valid for use with previously set up mapper data.

Parameters
pMaterial[in] Material ID.
Returns
true if the current material is valid for use with previously set up mapper data, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isLastProcValid() [2/5]

virtual bool OdGiMapperItem::isLastProcValid ( const OdDbStub *  pMaterial,
const OdGeMatrix3d tm 
)
pure virtual

Checks whether the current material and matrix are valid for use with previously set up mapper data.

Parameters
pMaterial[in] Material ID.
tm[in] Object/model transformation matrix.
Returns
true if the current material and matrix are valid for use with previously set up mapper data, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isLastProcValid() [3/5]

virtual bool OdGiMapperItem::isLastProcValid ( const OdGeMatrix3d tm)
pure virtual

Checks whether the current object/model matrix is valid for use with previously set up mapper data.

Parameters
tm[in] Object/model transformation matrix.
Returns
true if the current object/model matrix is valid for use with previously set up mapper data, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isLastProcValid() [4/5]

virtual bool OdGiMapperItem::isLastProcValid ( const OdGiMapper pMapper,
const OdDbStub *  pMaterial 
)
pure virtual

Checks whether the current mapper and material are valid for use with previously set up mapper data.

Parameters
pMapper[in] Entity mapper.
pMaterial[in] Material ID.
Returns
true if the current material and mapper are valid for use with previously set up mapper data, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isLastProcValid() [5/5]

virtual bool OdGiMapperItem::isLastProcValid ( const OdGiMapper pMapper,
const OdDbStub *  pMaterial,
const OdGeMatrix3d tm 
)
pure virtual

Checks whether the current mapper, material, and matrix are valid for use with previously set up mapper data.

Parameters
pMapper[in] Entity mapper.
pMaterial[in] Material ID.
tm[in] Object/model transformation matrix.
Returns
true if the current material, mapper and tranform matrix are valid for use with previously set up mapper data, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isModelMatrixNeed()

virtual bool OdGiMapperItem::isModelMatrixNeed ( ) const
pure virtual

Checks whether a model matrix is needed for this mapper.

Returns
true if mapper needs model matrix, false.

Implemented in OdGiMapperRenderItem.

◆ isObjectMatrixNeed()

virtual bool OdGiMapperItem::isObjectMatrixNeed ( ) const
pure virtual

Checks whether an object matrix is needed for this mapper.

Returns
true if mapper needs an object matrix, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ isVertexTransformRequired()

virtual bool OdGiMapperItem::isVertexTransformRequired ( ) const
pure virtual

Checks whether this mapper item requires a vertex transform.

Returns
true if mapper requires vertex transform, false otherwise.

Implemented in OdGiMapperRenderItem.

◆ ODRX_DECLARE_MEMBERS()

OdGiMapperItem::ODRX_DECLARE_MEMBERS ( OdGiMapperItem  )

◆ setDeviceTransform()

virtual void OdGiMapperItem::setDeviceTransform ( const OdGeMatrix3d dtm,
bool  recomputeTransforms = true 
)
pure virtual

Sets device-dependant transformation for all texture channels.

Parameters
dtm[in] Device transformation matrix.
recomputeTransforms[in] Flag that specifies whether to call recomputeTransformations() for all texture channels after matrix is set.

Implemented in OdGiMapperRenderItem.

◆ setDiffuseMapper() [1/4]

virtual void OdGiMapperItem::setDiffuseMapper ( const OdGiMapper pMapper,
const OdGiMaterialTraitsData traitsData 
)
pure virtual

Sets mapper for diffuse texture channel.

Parameters
pMapper[in] Entity mapper.
traitsData[in] Input traits data.

Implemented in OdGiMapperRenderItem.

◆ setDiffuseMapper() [2/4]

virtual void OdGiMapperItem::setDiffuseMapper ( const OdGiMapper pMapper,
const OdGiMaterialTraitsData traitsData,
const OdGeMatrix3d tm 
)
pure virtual

Sets mapper for diffuse texture channel.

Parameters
pMapper[in] Entity mapper.
traitsData[in] Input traits data.
tm[in] Object/model transformation matrix.

Implemented in OdGiMapperRenderItem.

◆ setDiffuseMapper() [3/4]

virtual void OdGiMapperItem::setDiffuseMapper ( const OdGiMaterialTraitsData traitsData)
pure virtual

Sets mapper for diffuse texture channel.

Parameters
traitsData[in] Input traits data.

Implemented in OdGiMapperRenderItem.

◆ setDiffuseMapper() [4/4]

virtual void OdGiMapperItem::setDiffuseMapper ( const OdGiMaterialTraitsData traitsData,
const OdGeMatrix3d tm 
)
pure virtual

Sets mapper for diffuse texture channel.

Parameters
traitsData[in] Input traits data.
tm[in] Object/model transformation matrix.

Implemented in OdGiMapperRenderItem.

◆ setInputTransform()

virtual void OdGiMapperItem::setInputTransform ( const OdGeMatrix3d tm,
bool  bVertexDependantOnly = true 
)
pure virtual

Sets input tranform for all channels.

Parameters
tm[in] Input transformation matrix.
bVertexDependantOnly[in] Flag that specifies whether to set transformation matrix only to channels which require vertex.

Implemented in OdGiMapperRenderItem.

◆ setMapper() [1/4]

virtual void OdGiMapperItem::setMapper ( const OdGiMapper pMapper,
const OdGiMaterialTraitsData traitsData,
const OdDbStub *  pMaterial = NULL 
)
pure virtual

Sets mapper for all texture channels.

Parameters
pMapper[in] Entity mapper.
traitsData[in] Input traits data.
pMaterial[in] Material ID for input traits data.

Implemented in OdGiMapperRenderItem.

◆ setMapper() [2/4]

virtual void OdGiMapperItem::setMapper ( const OdGiMapper pMapper,
const OdGiMaterialTraitsData traitsData,
const OdGeMatrix3d tm,
const OdDbStub *  pMaterial = NULL 
)
pure virtual

Sets mapper for all texture channels.

Parameters
pMapper[in] Entity mapper.
traitsData[in] Input traits data.
tm[in] Object/model transformation matrix.
pMaterial[in] Material ID for input traits data.

◆ setMapper() [3/4]

virtual void OdGiMapperItem::setMapper ( const OdGiMaterialTraitsData traitsData,
const OdDbStub *  pMaterial = NULL 
)
pure virtual

Sets mapper for all texture channels.

Parameters
traitsData[in] Input traits data.
pMaterial[in] Material ID for input traits data.

Implemented in OdGiMapperRenderItem.

◆ setMapper() [4/4]

virtual void OdGiMapperItem::setMapper ( const OdGiMaterialTraitsData traitsData,
const OdGeMatrix3d tm,
const OdDbStub *  pMaterial = NULL 
)
pure virtual

Sets mapper for all texture channels.

Parameters
traitsData[in] Input traits data.
tm[in] Object/model transformation matrix.
pMaterial[in] Material ID for input traits data.

◆ setModelTransform()

virtual void OdGiMapperItem::setModelTransform ( const OdGeMatrix3d mtm,
bool  recomputeTransforms = true 
)
pure virtual

Sets model transformation for all texture channels which needs model transformation.

Parameters
mtm[in] Model transformation matrix.
recomputeTransforms[in] Flag that specifies whether to call recomputeTransformations() for all texture channels after matrix is set.

Implemented in OdGiMapperRenderItem.

◆ setObjectTransform() [1/3]

virtual void OdGiMapperItem::setObjectTransform ( const OdGeExtents3d exts,
bool  recomputeTransforms = true 
)
pure virtual

Sets object transformation for all texture channels which needs object transformation.

Parameters
exts[in] Object extents.
recomputeTransforms[in] Flag that specifies whether to call recomputeTransformations() for all texture channels after matrix is set.

Implemented in OdGiMapperRenderItem.

◆ setObjectTransform() [2/3]

virtual void OdGiMapperItem::setObjectTransform ( const OdGeMatrix3d otm,
bool  recomputeTransforms = true 
)
pure virtual

Sets object transformation for all texture channels which needs object transformation.

Parameters
otm[in] Object transformation matrix.
recomputeTransforms[in] Flag that specifies whether to call recomputeTransformations() for all texture channels after matrix is set.

Implemented in OdGiMapperRenderItem.

◆ setObjectTransform() [3/3]

virtual void OdGiMapperItem::setObjectTransform ( OdInt32  nCount,
const OdGePoint3d pPoints,
bool  recomputeTransforms = true 
)
pure virtual

Sets object transformation for all texture channels which needs object transformation.

Parameters
nCount[in] Number of points into pPoints array.
pPoints[in] Pointer to an array of points.
recomputeTransforms[in] Flag that specifies whether to call recomputeTransformations() for all texture channels after matrix is set.

Implemented in OdGiMapperRenderItem.

◆ setVertexTransform() [1/2]

virtual void OdGiMapperItem::setVertexTransform ( const OdGeExtents3d exts)
pure virtual

Sets vertex transform from object extents for channels which needs vertex transformation.

Parameters
exts[in] Extents that defines vertex transform vertices.

Implemented in OdGiMapperRenderItem.

◆ setVertexTransform() [2/2]

virtual void OdGiMapperItem::setVertexTransform ( OdInt32  nCount,
const OdGePoint3d pPoints 
)
pure virtual

Sets vertex transform from points array for channels which needs vertex transformation.

Parameters
nCount[in] Number of transform points in the array.
pPoints[in] Pointer to an array of vertex transform points.

Implemented in OdGiMapperRenderItem.


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