OdGiLayerTraitsData Struct Reference

#include <GiLayerTraitsData.h>

Inheritance diagram for OdGiLayerTraitsData:

Public Member Functions
	OdGiLayerTraitsData ()
OdGiLayerTraitsData &	operator= (const OdGiLayerTraitsData &other)=default
OdUInt32	flags () const
OdDb::LineWeight	lineweight () const
OdDbStub *	linetype () const
OdDb::PlotStyleNameType	plotStyleNameType () const
OdDbStub *	plotStyleNameId () const
const OdCmEntityColor &	trueColor () const
OdDbStub *	materialId () const
OdCmTransparency	transparency () const
void	setTrueColor (const OdCmEntityColor &cl)
void	setLineweight (OdDb::LineWeight lw)
void	setLinetype (OdDbStub *id)
void	setMaterial (OdDbStub *id)
void	setTransparency (const OdCmTransparency &transparency)
bool	isOff () const
void	setOff (bool bVal)
bool	isPlottable () const
void	setPlottable (bool bVal)
bool	isLocked () const
void	setLocked (bool bVal)
bool	isFrozen () const
bool	isByBlock () const

Public Attributes
OdUInt32	m_flags
OdDb::LineWeight	m_lineweight
OdDb::PlotStyleNameType	m_plotStyleNameType
OdCmEntityColor	m_color
OdDbStub *	m_linetypeId
OdDbStub *	m_plotStyleNameId
OdDbStub *	m_materialId
OdCmTransparency	m_cmTransparency

Detailed Description

<group !!RECORDS_TD_APIRef>

See also

<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 73 of file GiLayerTraitsData.h.

Constructor & Destructor Documentation

OdGiLayerTraitsData()

OdGiLayerTraitsData::OdGiLayerTraitsData ( )

inline

Default constructor for the OdGiLayerTraitsData structure. Sets the following data members:

Data member Value Description m_flags OdGiLayerTraits::kPlottable Layer traits flags m_lineweight OdDb::kLnWtByLwDefault LineWeight. m_plotStyleNameType OdDb::kPlotStyleNameById Plot style name type. m_color OdCmEntityColor::kForeground Layer color. m_linetypeId 0 Linetype identifier. m_plotStyleNameId 0 Plot style name identifier. m_materialId 0 Material identifier. m_cmTransparency OdUInt8(0xFF) Transparency color.

Definition at line 89 of file GiLayerTraitsData.h.

Member Function Documentation

flags()

OdUInt32 OdGiLayerTraitsData::flags ( ) const

inline

Retrieves layer traits flags.

Definition at line 111 of file GiLayerTraitsData.h.

isByBlock()

bool OdGiLayerTraitsData::isByBlock ( ) const

inline

Checks whether this layer inherits traits by block.

Returns

true if this layer takes traits from block, false otherwise.

Definition at line 253 of file GiLayerTraitsData.h.

isFrozen()

bool OdGiLayerTraitsData::isFrozen ( ) const

inline

Checks whether this layer is frozen.

Returns

true if this layer is frozen, false otherwise.

Definition at line 246 of file GiLayerTraitsData.h.

isLocked()

bool OdGiLayerTraitsData::isLocked ( ) const

inline

Checks whether this layer is locked.

Returns

true if this layer is locked, false otherwise.

Definition at line 233 of file GiLayerTraitsData.h.

isOff()

bool OdGiLayerTraitsData::isOff ( ) const

inline

Checks whether this layer is turned off.

Returns

true if this layer is off, false otherwise.

Definition at line 207 of file GiLayerTraitsData.h.

isPlottable()

bool OdGiLayerTraitsData::isPlottable ( ) const

inline

Checks whether this layer is plottable.

Returns

true if this layer is plottable, false otherwise.

Definition at line 220 of file GiLayerTraitsData.h.

linetype()

OdDbStub * OdGiLayerTraitsData::linetype ( ) const

inline

Retrieves persistent linetype identifier associated with the layer.

See also

<exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Definition at line 125 of file GiLayerTraitsData.h.

lineweight()

OdDb::LineWeight OdGiLayerTraitsData::lineweight ( ) const

inline

Retrieves lineweight associated with this layer.

See also

<link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 118 of file GiLayerTraitsData.h.

materialId()

OdDbStub * OdGiLayerTraitsData::materialId ( ) const

inline

Retrieves persistent material identifier associated with the layer.

See also

<link tv_working_with_attributes_materials, Work with Materials>

Definition at line 149 of file GiLayerTraitsData.h.

operator=()

OdGiLayerTraitsData & OdGiLayerTraitsData::operator= ( const OdGiLayerTraitsData & other )

default

Assignment operator for the OdGiLayerTraitsData class.

Parameters

other

[in] Properties of other OdGiLayerTraitsData object to assign.

plotStyleNameId()

OdDbStub * OdGiLayerTraitsData::plotStyleNameId ( ) const

inline

Retrieves persistent plot style name identifier associated with the layer.

Definition at line 135 of file GiLayerTraitsData.h.

plotStyleNameType()

OdDb::PlotStyleNameType OdGiLayerTraitsData::plotStyleNameType ( ) const

inline

Retrieves plot style name type of this layer.

Definition at line 130 of file GiLayerTraitsData.h.

setLinetype()

void OdGiLayerTraitsData::setLinetype ( OdDbStub * id )

inline

Sets linetype for this layer.

Parameters

id	[in] Persistent identifier of a linetype to set.

See also

<exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Definition at line 182 of file GiLayerTraitsData.h.

setLineweight()

void OdGiLayerTraitsData::setLineweight ( OdDb::LineWeight lw )

inline

Sets lineweight associated for this layer.

Parameters

lw	[in] LineWeight to set.

See also

<link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 174 of file GiLayerTraitsData.h.

setLocked()

void OdGiLayerTraitsData::setLocked ( bool bVal )

inline

Specifies whether this layer is locked.

Parameters

bVal	[in] Flag that specifies whether this layer should be locked.

Definition at line 239 of file GiLayerTraitsData.h.

setMaterial()

void OdGiLayerTraitsData::setMaterial ( OdDbStub * id )

inline

Sets material for this layer.

Parameters

id	[in] Persistent identifier of a material to set.

See also

<link tv_working_with_attributes_materials, Work with Materials>

Definition at line 190 of file GiLayerTraitsData.h.

setOff()

void OdGiLayerTraitsData::setOff ( bool bVal )

inline

Switches the layer on or off.

Parameters

bVal	[in] Layer state.

Definition at line 213 of file GiLayerTraitsData.h.

setPlottable()

void OdGiLayerTraitsData::setPlottable ( bool bVal )

inline

Specifies whether this layer is plottable.

Parameters

bVal	[in] Flag that specifies whether this layer should be plottable.

Definition at line 226 of file GiLayerTraitsData.h.

setTransparency()

void OdGiLayerTraitsData::setTransparency ( const OdCmTransparency & transparency )

inline

Sets transparency for this layer.

Parameters

transparency

[in] Transparency to set.

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>

Definition at line 200 of file GiLayerTraitsData.h.

setTrueColor()

void OdGiLayerTraitsData::setTrueColor ( const OdCmEntityColor & cl )

inline

Sets color for this layer.

Parameters

cl	[in] Color to set.

See also

<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 166 of file GiLayerTraitsData.h.

transparency()

OdCmTransparency OdGiLayerTraitsData::transparency ( ) const

inline

Retrieves transparency associated with the layer.

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>

Definition at line 158 of file GiLayerTraitsData.h.

trueColor()

const OdCmEntityColor & OdGiLayerTraitsData::trueColor ( ) const

inline

Retrieves color for this layer.

See also

<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 142 of file GiLayerTraitsData.h.

Member Data Documentation

m_cmTransparency

OdCmTransparency OdGiLayerTraitsData::m_cmTransparency

Transparency for this layer.

Definition at line 272 of file GiLayerTraitsData.h.

m_color

OdCmEntityColor OdGiLayerTraitsData::m_color

Color for this layer.

Definition at line 263 of file GiLayerTraitsData.h.

m_flags

OdUInt32 OdGiLayerTraitsData::m_flags

Retrieves layer traits flags.

Definition at line 256 of file GiLayerTraitsData.h.

m_linetypeId

OdDbStub* OdGiLayerTraitsData::m_linetypeId

Persistent linetype identifier associated with the layer.

Definition at line 265 of file GiLayerTraitsData.h.

m_lineweight

OdDb::LineWeight OdGiLayerTraitsData::m_lineweight

Lineweight associated with this layer.

Definition at line 258 of file GiLayerTraitsData.h.

m_materialId

OdDbStub* OdGiLayerTraitsData::m_materialId

Persistent material identifier associated with the layer.

Definition at line 270 of file GiLayerTraitsData.h.

m_plotStyleNameId

OdDbStub* OdGiLayerTraitsData::m_plotStyleNameId

Persistent plot style name identifier associated with the layer.

Definition at line 267 of file GiLayerTraitsData.h.

m_plotStyleNameType

OdDb::PlotStyleNameType OdGiLayerTraitsData::m_plotStyleNameType

Plot style name type of this layer.

Definition at line 260 of file GiLayerTraitsData.h.

---

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

• GiLayerTraitsData.h