CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
OdGiLayerTraits Class Referenceabstract

#include <GiNonEntityTraits.h>

Inheritance diagram for OdGiLayerTraits:
OdGiDrawableTraits OdRxObject OdGiLayerTraits_ OdGiLayerTraitsTaker OdGiLayerTraitsTakerView

Public Types

enum  {
  kByBlock = (OdGiDrawable::kLastFlag << 1) , kFrozen = (OdGiDrawable::kLastFlag << 2) , kOff = (OdGiDrawable::kLastFlag << 3) , kPlottable = (OdGiDrawable::kLastFlag << 4) ,
  kLocked = (OdGiDrawable::kLastFlag << 5)
}
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiLayerTraits)
 
virtual OdCmEntityColor color () const =0
 
virtual OdDb::LineWeight lineweight () const =0
 
virtual OdDbStub * linetype () const =0
 
virtual OdDb::PlotStyleNameType plotStyleNameType () const =0
 
virtual OdDbStub * plotStyleNameId () const =0
 
virtual OdDbStub * materialId () const =0
 
virtual OdCmTransparency transparency () const =0
 
virtual void setColor (const OdCmEntityColor &color)=0
 
virtual void setLineweight (OdDb::LineWeight lineweight)=0
 
virtual void setLinetype (OdDbStub *pLinetypeId)=0
 
virtual void setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbStub *pPlotStyleNameId=0)=0
 
virtual void setMaterial (OdDbStub *pMaterialId)=0
 
virtual void setTransparency (const OdCmTransparency &transparency)=0
 
- Public Member Functions inherited from OdGiDrawableTraits
 ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
 
- 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

This class defines the interface to the layer traits for the vectorization process.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 44 of file GiNonEntityTraits.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kByBlock 
kFrozen 
kOff 
kPlottable 
kLocked 

Definition at line 51 of file GiNonEntityTraits.h.

Member Function Documentation

◆ color()

virtual OdCmEntityColor OdGiLayerTraits::color ( ) const
pure virtual

Returns the color for this object.

Implemented in OdGiLayerTraits_.

◆ linetype()

virtual OdDbStub* OdGiLayerTraits::linetype ( ) const
pure virtual

Returns the Object ID of the linetype for this object.

Implemented in OdGiLayerTraitsTaker.

◆ lineweight()

virtual OdDb::LineWeight OdGiLayerTraits::lineweight ( ) const
pure virtual

Returns the lineweight for this object.

Implemented in OdGiLayerTraitsTaker.

◆ materialId()

virtual OdDbStub* OdGiLayerTraits::materialId ( ) const
pure virtual

Returns the Object ID of the material.

Implemented in OdGiLayerTraitsTaker.

◆ ODRX_DECLARE_MEMBERS()

OdGiLayerTraits::ODRX_DECLARE_MEMBERS ( OdGiLayerTraits  )

◆ plotStyleNameId()

virtual OdDbStub* OdGiLayerTraits::plotStyleNameId ( ) const
pure virtual

Returns the Object ID of the Plot Style Name.

Implemented in OdGiLayerTraitsTaker.

◆ plotStyleNameType()

virtual OdDb::PlotStyleNameType OdGiLayerTraits::plotStyleNameType ( ) const
pure virtual

Returns the Plot Style Name Type for this object.

Remarks
plotStyleNameType() returns one of the following:

Value
OdDb::kPlotStyleNameByLayer 0 OdDb::kPlotStyleNameByBlock 1 OdDb::kPlotStyleNameIsDictDefault 2 OdDb::kPlotStyleNameById 3

Implemented in OdGiLayerTraitsTaker.

◆ setColor()

virtual void OdGiLayerTraits::setColor ( const OdCmEntityColor color)
pure virtual

Sets the color for this object.

Parameters
color[in] Entity color.

Implemented in OdGiLayerTraitsTaker.

◆ setLinetype()

virtual void OdGiLayerTraits::setLinetype ( OdDbStub *  pLinetypeId)
pure virtual

Sets the linetype for this object.

Parameters
pLinetypeId[in] Pointer to the Object ID of the linetype.

Implemented in OdGiLayerTraitsTaker.

◆ setLineweight()

virtual void OdGiLayerTraits::setLineweight ( OdDb::LineWeight  lineweight)
pure virtual

Sets the lineweight for this object.

Parameters
lineweight[in] Lineweight.

Implemented in OdGiLayerTraitsTaker.

◆ setMaterial()

virtual void OdGiLayerTraits::setMaterial ( OdDbStub *  pMaterialId)
pure virtual

Sets the material ID for this object.

Parameters
pMaterialId[in] Pointer to the Object ID of the material.

Implemented in OdGiLayerTraitsTaker.

◆ setPlotStyleName()

virtual void OdGiLayerTraits::setPlotStyleName ( OdDb::PlotStyleNameType  plotStyleNameType,
OdDbStub *  pPlotStyleNameId = 0 
)
pure virtual

Sets the Plot Style Name for this object.

Parameters
plotStyleNameType[in] Plot Style Name Type.
pPlotStyleNameId[in] Pointer to the Object ID of the Plot Style Name.
Remarks
pPlotStyleNameId is used only when plotStyleNameType == kPlotStyleNameById.

plotStyleNameType must be one of the following:

Value
OdDb::kPlotStyleNameByLayer 0 OdDb::kPlotStyleNameByBlock 1 OdDb::kPlotStyleNameIsDictDefault 2 OdDb::kPlotStyleNameById 3

Implemented in OdGiLayerTraitsTaker.

◆ setTransparency()

virtual void OdGiLayerTraits::setTransparency ( const OdCmTransparency transparency)
pure virtual

Sets the transparency for this object.

Parameters
transparency[in] OdCmTransparency object.

Implemented in OdGiLayerTraitsTaker.

◆ transparency()

virtual OdCmTransparency OdGiLayerTraits::transparency ( ) const
pure virtual

Returns the transparency for this object.

Implemented in OdGiLayerTraitsTaker.


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