OdGiSubEntityTraitsData Class Reference

#include <GiSubEntityTraitsData.h>

Inheritance diagram for OdGiSubEntityTraitsData:

Public Types
enum	{ kSelectionGeom = 0x100 , kSectionable = 0x200 , kInheritableSelFlags = kSectionable , kSelectionFlagsMask = 0xFF }
enum	{ kLayerOff = 1 , kLayerFrozen = 2 }
enum	{   kGeomDisplayNormally = (1 << 0) , kGeomSelectNormally = (1 << 1) , kGeomDisplayHighlighted = (1 << 2) , kGeomSelectHighlighted = (1 << 3) ,   kGeomAllVisibilityFlags = 0x0F }

Public Member Functions
	OdGiSubEntityTraitsData ()
OdUInt16	flags () const
OdUInt16	selFlags () const
OdUInt16	geomVisibilityFlags () const
OdUInt16	geomVisibilityFlags (bool bHighlighted) const
bool	isLayerFrozen () const
bool	isLayerOff () const
bool	isLayerVisible () const
bool	visibility () const
const OdCmEntityColor &	trueColor () const
OdUInt16	color () const
OdDbStub *	layer () const
OdDbStub *	lineType () const
OdGiFillType	fillType () const
OdDb::LineWeight	lineWeight () const
double	lineTypeScale () const
double	thickness () const
OdDb::PlotStyleNameType	plotStyleNameType () const
OdDbStub *	plotStyleNameId () const
OdDbStub *	material () const
const OdGiMapper *	mapper () const
OdDbStub *	visualStyle () const
const OdCmTransparency &	transparency () const
OdUInt32	drawFlags () const
OdUInt32	lockFlags () const
bool	selectionGeom () const
OdGiSubEntityTraits::ShadowFlags	shadowFlags () const
bool	sectionable () const
OdGiSubEntityTraits::SelectionFlags	selectionFlags () const
const OdCmEntityColor &	secondaryTrueColor () const
const OdGiDgLinetypeModifiers *	lineStyleModifiers () const
const OdGiFill *	fill () const
OdGiAuxiliaryDataPtr	auxData () const
void	setFlags (OdUInt16 flags)
void	setSelFlags (OdUInt16 selFlags)
void	setTrueColor (const OdCmEntityColor &trueColor)
void	setColor (OdUInt16 colorIndex)
void	setLayer (OdDbStub *layerId)
void	setLineType (OdDbStub *lineTypeId)
void	setFillType (OdGiFillType fillType)
void	setLineWeight (OdDb::LineWeight lineWeight)
void	setLineTypeScale (double lineTypeScale)
void	setThickness (double thickness)
void	setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbStub *pPlotStyleNameId)
void	setMaterial (OdDbStub *materialId)
void	setMapper (const OdGiMapper *pMapper)
void	setVisualStyle (OdDbStub *visualStyleId)
void	setTransparency (const OdCmTransparency &transparency)
void	setDrawFlags (OdUInt32 drawFlags)
void	setLockFlags (OdUInt32 lockFlags)
void	setSelectionGeom (bool bSelectionFlag)
void	setShadowFlags (OdGiSubEntityTraits::ShadowFlags shadowFlags)
void	setSectionable (bool bSectionableFlag)
void	setSelectionFlags (OdGiSubEntityTraits::SelectionFlags selectionFlags)
void	setSecondaryTrueColor (const OdCmEntityColor &trueColor)
void	setLineStyleModifiers (const OdGiDgLinetypeModifiers *pLSMod)
void	setFill (const OdGiFill *pFill)
void	setAuxData (const OdGiAuxiliaryDataPtr &pAuxData)

Detailed Description

<group OdGi_Classes>

Definition at line 99 of file GiSubEntityTraitsData.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kSelectionGeom
kSectionable
kInheritableSelFlags
kSelectionFlagsMask

Definition at line 127 of file GiSubEntityTraitsData.h.

anonymous enum

anonymous enum

Enumerator
kLayerOff
kLayerFrozen

Definition at line 135 of file GiSubEntityTraitsData.h.

anonymous enum

anonymous enum

Enumerator
kGeomDisplayNormally
kGeomSelectNormally
kGeomDisplayHighlighted
kGeomSelectHighlighted
kGeomAllVisibilityFlags

Definition at line 142 of file GiSubEntityTraitsData.h.

Constructor & Destructor Documentation

OdGiSubEntityTraitsData()

OdGiSubEntityTraitsData::OdGiSubEntityTraitsData ( )

inline

Default constructor for the OdGiSubEntityTraitsData class. Sets the following data members:

Value Description m_flags 0 Image width in pixels. m_selFlags 0 Selection flags. m_cmColor OdCmEntityColor::kForeground Subentity color (set to the same color as foreground). m_layerId NULL Layer identifier. m_lineTypeId NULL Linetype identifier. m_fillType kOdGiFillNever Fill type (never fills closed graphic primitives). m_lineWeight OdDb::kLnWt000 Lineweight. m_lineTypeScale 1.0 Linetype scale. m_thickness 0.0 Subentity thickness. m_plotStyleNameType OdDb::kPlotStyleNameIsDictDefault Plot style name type (default). m_plotStyleNameId NULL Identifier of the plot style name. m_materialId NULL Material identifier. m_mapper NULL Mapper identifier. m_visualStyleId NULL Visual style identifier. m_cmTransparency OdUInt8(0xFF) Transparency value for subentity. m_drawFlags 0 Draw flags. m_lockFlags 0 Lock flags. m_shadowFlags OdGiSubEntityTraits::kShadowsCastAndReceive Shadow flags (subentities cast and receive shadows). m_cmSecondaryColor OdCmEntityColor::kForeground Secondary color. m_lsModifiers NULL Linetype modifier. m_fill NULL The fill object for subentity.

Definition at line 178 of file GiSubEntityTraitsData.h.

Member Function Documentation

auxData()

OdGiAuxiliaryDataPtr OdGiSubEntityTraitsData::auxData ( ) const

inline

Retrieves a smart pointer to the auxiliary data for this subentity.

Definition at line 727 of file GiSubEntityTraitsData.h.

color()

OdUInt16 OdGiSubEntityTraitsData::color ( ) const

inline

Retrieves subentity color index.

See also

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

Definition at line 635 of file GiSubEntityTraitsData.h.

drawFlags()

OdUInt32 OdGiSubEntityTraitsData::drawFlags ( ) const

inline

Retrieves the draw flags for this subentity.

Definition at line 691 of file GiSubEntityTraitsData.h.

fill()

const OdGiFill * OdGiSubEntityTraitsData::fill ( ) const

inline

Retrieves the fill for this subentity as a pointer to OdGiFill.

Definition at line 723 of file GiSubEntityTraitsData.h.

fillType()

OdGiFillType OdGiSubEntityTraitsData::fillType ( ) const

inline

Retrieves subentity fill type.

Definition at line 651 of file GiSubEntityTraitsData.h.

flags()

OdUInt16 OdGiSubEntityTraitsData::flags ( ) const

inline

Retrieves subentity flags.

Definition at line 595 of file GiSubEntityTraitsData.h.

geomVisibilityFlags() [1/2]

OdUInt16 OdGiSubEntityTraitsData::geomVisibilityFlags ( ) const

inline

Retrieves visibility flags.

Definition at line 603 of file GiSubEntityTraitsData.h.

geomVisibilityFlags() [2/2]

OdUInt16 OdGiSubEntityTraitsData::geomVisibilityFlags ( bool  bHighlighted ) const

inline

Gets first two visibility flags if the passed highlighting state is false, or all visibility flags if bHighlighted is true.

Parameters

bHighlighted

[in] The highlighting state.

Definition at line 618 of file GiSubEntityTraitsData.h.

isLayerFrozen()

bool OdGiSubEntityTraitsData::isLayerFrozen ( ) const

inline

Checks whether layer that contains this subentity is frozen.

Returns

true if the layer is frozen, false otherwise.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 627 of file GiSubEntityTraitsData.h.

isLayerOff()

bool OdGiSubEntityTraitsData::isLayerOff ( ) const

inline

Checks whether layer that contains this subentity is turned off.

Returns

true if the layer is turned off, false otherwise.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 631 of file GiSubEntityTraitsData.h.

isLayerVisible()

bool OdGiSubEntityTraitsData::isLayerVisible ( ) const

inline

Checks whether layer that contains this subentity is visible.

Returns

true if the layer is visible, false otherwise.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 623 of file GiSubEntityTraitsData.h.

layer()

OdDbStub * OdGiSubEntityTraitsData::layer ( ) const

inline

Retrieves layer identifier as pointer to OdDbStub.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 643 of file GiSubEntityTraitsData.h.

lineStyleModifiers()

const OdGiDgLinetypeModifiers * OdGiSubEntityTraitsData::lineStyleModifiers ( ) const

inline

Retrieves the linetype modifiers for this subentity as a pointer to OdGiDgLinetypeModifiers.

Definition at line 719 of file GiSubEntityTraitsData.h.

lineType()

OdDbStub * OdGiSubEntityTraitsData::lineType ( ) const

inline

Retrieves linetype identifier as pointer to OdDbStub.

See also

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

Definition at line 647 of file GiSubEntityTraitsData.h.

lineTypeScale()

double OdGiSubEntityTraitsData::lineTypeScale ( ) const

inline

Retrieves linetype scale for this subentity.

See also

<exref target="https://docs.opendesign.com/td/db_linetype_properties.html">Specific Properties of Linetypes</exref>

Definition at line 659 of file GiSubEntityTraitsData.h.

lineWeight()

OdDb::LineWeight OdGiSubEntityTraitsData::lineWeight ( ) const

inline

Retrieves lineweight for this subentity.

See also

<link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 655 of file GiSubEntityTraitsData.h.

lockFlags()

OdUInt32 OdGiSubEntityTraitsData::lockFlags ( ) const

inline

Retrieves the lock flags for this subentity.

Definition at line 695 of file GiSubEntityTraitsData.h.

mapper()

const OdGiMapper * OdGiSubEntityTraitsData::mapper ( ) const

inline

Retrieves mapper for this subentity.

See also

<link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Definition at line 679 of file GiSubEntityTraitsData.h.

material()

OdDbStub * OdGiSubEntityTraitsData::material ( ) const

inline

Retrieves material identifier for this subentity.

See also

<link tv_working_with_attributes_materials, Work with Materials>

Definition at line 675 of file GiSubEntityTraitsData.h.

plotStyleNameId()

OdDbStub * OdGiSubEntityTraitsData::plotStyleNameId ( ) const

inline

Retrieves plot style name identifier for this subentity.

Definition at line 671 of file GiSubEntityTraitsData.h.

plotStyleNameType()

OdDb::PlotStyleNameType OdGiSubEntityTraitsData::plotStyleNameType ( ) const

inline

Retrieves plot style name type for this subentity.

Definition at line 667 of file GiSubEntityTraitsData.h.

secondaryTrueColor()

const OdCmEntityColor & OdGiSubEntityTraitsData::secondaryTrueColor ( ) const

inline

Retrieves the secondary color for this subentity as a reference to OdCmEntityColor.

Definition at line 715 of file GiSubEntityTraitsData.h.

sectionable()

bool OdGiSubEntityTraitsData::sectionable ( ) const

inline

Checks whether this subentity is sectionable.

Returns

true if this subentity is sectionable, false otherwise.

See also

<link tv_planarClip_sample, Planar Clipping Section Generation for a Custom Entity>

Definition at line 707 of file GiSubEntityTraitsData.h.

selectionFlags()

OdGiSubEntityTraits::SelectionFlags OdGiSubEntityTraitsData::selectionFlags ( ) const

inline

Retrieves the selection flags for this subentity.

Definition at line 711 of file GiSubEntityTraitsData.h.

selectionGeom()

bool OdGiSubEntityTraitsData::selectionGeom ( ) const

inline

Retrieves the selection geometry flag for this subentity.

See also

<link tv_working_with_features_selections, Work with Selections>

Definition at line 699 of file GiSubEntityTraitsData.h.

selFlags()

OdUInt16 OdGiSubEntityTraitsData::selFlags ( ) const

inline

Retrieves selection flags.

Definition at line 599 of file GiSubEntityTraitsData.h.

setAuxData()

void OdGiSubEntityTraitsData::setAuxData ( const OdGiAuxiliaryDataPtr &  pAuxData )

inline

Sets the auxiliary data for this subentity.

Parameters

pAuxData

[in] Smart pointer to the auxiliary data.

Definition at line 847 of file GiSubEntityTraitsData.h.

setColor()

void OdGiSubEntityTraitsData::setColor ( OdUInt16  colorIndex )

inline

Sets the color index for this subentity.

Parameters

trueColor

[in] Color object to set.

See also

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

Definition at line 744 of file GiSubEntityTraitsData.h.

setDrawFlags()

void OdGiSubEntityTraitsData::setDrawFlags ( OdUInt32  drawFlags )

inline

Sets the draw flags for this subentity.

Parameters

drawFlags

[in] Draw flags.

Definition at line 810 of file GiSubEntityTraitsData.h.

setFill()

void OdGiSubEntityTraitsData::setFill ( const OdGiFill *  pFill )

inline

Sets the fill for this subentity.

Parameters

pFill

[in] Pointer to the subentity fill.

Definition at line 842 of file GiSubEntityTraitsData.h.

setFillType()

void OdGiSubEntityTraitsData::setFillType ( OdGiFillType  fillType )

inline

Sets the fill type for this subentity.

Parameters

fillType

[in] Pointer to the persistent linetype identifier.

Definition at line 773 of file GiSubEntityTraitsData.h.

setFlags()

void OdGiSubEntityTraitsData::setFlags ( OdUInt16  flags )

inline

Sets the subentity flags.

Parameters

flags

[in] Flags to set.

Definition at line 732 of file GiSubEntityTraitsData.h.

setLayer()

void OdGiSubEntityTraitsData::setLayer ( OdDbStub *  layerId )

inline

Sets the layer for this subentity.

Parameters

layerId

[in] Pointer to the persistent layer identifier.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 748 of file GiSubEntityTraitsData.h.

setLineStyleModifiers()

void OdGiSubEntityTraitsData::setLineStyleModifiers ( const OdGiDgLinetypeModifiers *  pLSMod )

inline

Sets the line style modifiers.

Parameters

pLSMod

[in] Pointer to the line style modifiers.

Definition at line 838 of file GiSubEntityTraitsData.h.

setLineType()

void OdGiSubEntityTraitsData::setLineType ( OdDbStub *  lineTypeId )

inline

Sets the layer for this subentity.

Parameters

lineTypeId

[in] Pointer to the persistent linetype identifier.

See also

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

Definition at line 769 of file GiSubEntityTraitsData.h.

setLineTypeScale()

void OdGiSubEntityTraitsData::setLineTypeScale ( double  lineTypeScale )

inline

Sets the linetype scale for this subentity.

Parameters

lineTypeScale

[in] Linetype scale.

See also

<exref target="https://docs.opendesign.com/td/db_linetype_properties.html">Specific Properties of Linetypes</exref>

Definition at line 781 of file GiSubEntityTraitsData.h.

setLineWeight()

void OdGiSubEntityTraitsData::setLineWeight ( OdDb::LineWeight  lineWeight )

inline

Sets the lineweight for this subentity.

Parameters

lineWeight

[in] LineWeight.

See also

<link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 777 of file GiSubEntityTraitsData.h.

setLockFlags()

void OdGiSubEntityTraitsData::setLockFlags ( OdUInt32  lockFlags )

inline

Sets the lock flags for this subentity.

Parameters

lockFlags

[in] Lock flags.

Definition at line 814 of file GiSubEntityTraitsData.h.

setMapper()

void OdGiSubEntityTraitsData::setMapper ( const OdGiMapper *  pMapper )

inline

Sets the mapper for this subentity.

Parameters

pMapper

[in] Pointer to the mapper.

See also

<link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Definition at line 798 of file GiSubEntityTraitsData.h.

setMaterial()

void OdGiSubEntityTraitsData::setMaterial ( OdDbStub *  materialId )

inline

Sets the material for this subentity.

Parameters

materialId

[in] Pointer to the material identifier.

See also

<link tv_working_with_attributes_materials, Work with Materials>

Definition at line 794 of file GiSubEntityTraitsData.h.

setPlotStyleName()

void OdGiSubEntityTraitsData::setPlotStyleName ( OdDb::PlotStyleNameType  plotStyleNameType, OdDbStub *  pPlotStyleNameId  )

inline

Sets the plot style name and type for this subentity.

Parameters

plotStyleNameType	[in] Plot style name type.
pPlotStyleNameId	[in] Pointer to the plot style name identifier.

Definition at line 789 of file GiSubEntityTraitsData.h.

setSecondaryTrueColor()

void OdGiSubEntityTraitsData::setSecondaryTrueColor ( const OdCmEntityColor &  trueColor )

inline

Sets the secondary true color for this subentity.

Parameters

trueColor

[in] Secondary true color.

Definition at line 834 of file GiSubEntityTraitsData.h.

setSectionable()

void OdGiSubEntityTraitsData::setSectionable ( bool  bSectionableFlag )

inline

Specifies whether the subentity should be sectionable.

Parameters

bSectionableFlag

[in] Flag that specifies whether this subentity should be sectionable.

See also

<link tv_planarClip_sample, Planar Clipping Section Generation for a Custom Entity>

Definition at line 826 of file GiSubEntityTraitsData.h.

setSelectionFlags()

void OdGiSubEntityTraitsData::setSelectionFlags ( OdGiSubEntityTraits::SelectionFlags  selectionFlags )

inline

Sets the selection flags for this subentity.

Parameters

selectionFlags

[in] Selection flags.

Definition at line 830 of file GiSubEntityTraitsData.h.

setSelectionGeom()

void OdGiSubEntityTraitsData::setSelectionGeom ( bool  bSelectionFlag )

inline

Sets the geometry selection flags for this subentity.

Parameters

bSelectionFlag

[in] Lock flags.

See also

<link tv_working_with_features_selections, Work with Selections>

Definition at line 818 of file GiSubEntityTraitsData.h.

setSelFlags()

void OdGiSubEntityTraitsData::setSelFlags ( OdUInt16  selFlags )

inline

Sets the selection flags.

Parameters

selFlags

[in] Selection flags to set.

Definition at line 736 of file GiSubEntityTraitsData.h.

setShadowFlags()

void OdGiSubEntityTraitsData::setShadowFlags ( OdGiSubEntityTraits::ShadowFlags  shadowFlags )

inline

Sets the shadow flags for this subentity.

Parameters

shadowFlags

[in] Shadow flags.

See also

<link gi_shadows_rendering, Shadows Visualization>

Definition at line 822 of file GiSubEntityTraitsData.h.

setThickness()

void OdGiSubEntityTraitsData::setThickness ( double  thickness )

inline

Sets the thickness for this subentity.

Parameters

thickness

[in] Thickness in drawing units.

Definition at line 785 of file GiSubEntityTraitsData.h.

setTransparency()

void OdGiSubEntityTraitsData::setTransparency ( const OdCmTransparency &  transparency )

inline

Sets the transparency object for this subentity.

Parameters

transparency

[in] Transparency data.

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 806 of file GiSubEntityTraitsData.h.

setTrueColor()

void OdGiSubEntityTraitsData::setTrueColor ( const OdCmEntityColor &  trueColor )

inline

Sets true color for this subentity.

Parameters

trueColor

[in] Color object to set.

See also

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

Definition at line 740 of file GiSubEntityTraitsData.h.

setVisualStyle()

void OdGiSubEntityTraitsData::setVisualStyle ( OdDbStub *  visualStyleId )

inline

Sets the visual style identifier for this subentity.

Parameters

visualStyleId

[in] Pointer to the visual style identifier.

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 802 of file GiSubEntityTraitsData.h.

shadowFlags()

OdGiSubEntityTraits::ShadowFlags OdGiSubEntityTraitsData::shadowFlags ( ) const

inline

Retrieves the shadow flags for this subentity.

See also

<link gi_shadows_rendering, Shadows Visualization>

Definition at line 703 of file GiSubEntityTraitsData.h.

thickness()

double OdGiSubEntityTraitsData::thickness ( ) const

inline

Retrieves thickness for this subentity.

Definition at line 663 of file GiSubEntityTraitsData.h.

transparency()

const OdCmTransparency & OdGiSubEntityTraitsData::transparency ( ) const

inline

Retrieves transparency for this subentity as reference to OdCmTransparency.

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 687 of file GiSubEntityTraitsData.h.

trueColor()

const OdCmEntityColor & OdGiSubEntityTraitsData::trueColor ( ) const

inline

Retrieves subentity true color as a reference to OdCmEntityColor.

See also

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

Definition at line 639 of file GiSubEntityTraitsData.h.

visibility()

bool OdGiSubEntityTraitsData::visibility ( ) const

inline

Checks whether layer that contains this subentity is visible.

Returns

true if the layer is visible, false otherwise.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 260 of file GiSubEntityTraitsData.h.

visualStyle()

OdDbStub * OdGiSubEntityTraitsData::visualStyle ( ) const

inline

Retrieves visual style identifier for this subentity.

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 683 of file GiSubEntityTraitsData.h.

---

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

• GiSubEntityTraitsData.h