CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
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>

See also
<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 46 of file GiNonEntityTraits.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kByBlock 

Traits inherited by block.

kFrozen 

Frozen layer.

kOff 

Layer is switched off.

kPlottable 

Layer is plottable.

kLocked 

Layer is locked.

Definition at line 53 of file GiNonEntityTraits.h.

Member Function Documentation

◆ color()

virtual OdCmEntityColor OdGiLayerTraits::color ( ) const
pure virtual

Retrieves the color for this object.

Returns
color as OdCmEntityColor instance.
See also
<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Implemented in OdGiLayerTraits_.

◆ linetype()

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

Retrieves the Object ID of the linetype for this object.

Returns
pointer to OdDbStub that represents linetype identifier in database.
See also
<exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implemented in OdGiLayerTraitsTaker.

◆ lineweight()

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

Retrieves the lineweight for this object.

Returns
lineweight as a value from the OdDb::LineWeight enumeration.
See also
<link tv_working_with_attributes_lineweights, Work with Lineweights>

Implemented in OdGiLayerTraitsTaker.

◆ materialId()

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

Retrieves the Object ID of the material.

Returns
pointer to OdDbStub that represents a material identifier in database.
See also
<link tv_working_with_attributes_materials, Work with Materials>

Implemented in OdGiLayerTraitsTaker.

◆ ODRX_DECLARE_MEMBERS()

OdGiLayerTraits::ODRX_DECLARE_MEMBERS ( OdGiLayerTraits  )

◆ plotStyleNameId()

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

Retrieves the Object ID of the Plot Style Name.

Returns
pointer to OdDbStub that represents a plotStyleName identifier in database.

Implemented in OdGiLayerTraitsTaker.

◆ plotStyleNameType()

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

Returns the Plot Style Name Type for this object.

Returns
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.
See also
<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

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.
See also
<exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implemented in OdGiLayerTraitsTaker.

◆ setLineweight()

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

Sets the lineweight for this object.

Parameters
lineweight[in] Lineweight.
See also
<link tv_working_with_attributes_lineweights, Work with Lineweights>

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.
See also
<exref target="https://docs.opendesign.com/td/cm_transparency_alpha.html">Transparency Functionality as an Alpha-value</exref>
<exref target="https://docs.opendesign.com/td/cm_transparency_integer.html">Transparency Functionality as an Integer-value</exref>

Implemented in OdGiLayerTraitsTaker.

◆ transparency()

virtual OdCmTransparency OdGiLayerTraits::transparency ( ) const
pure virtual

Retrieves the transparency for this object.

Returns
transparency as OdCmTransparency instance.
See also
<exref target="https://docs.opendesign.com/td/cm_transparency_alpha.html">Transparency Functionality as an Alpha-value</exref>
<exref target="https://docs.opendesign.com/td/cm_transparency_integer.html">Transparency Functionality as an Integer-value</exref>

Implemented in OdGiLayerTraitsTaker.


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