OdGiSubEntityTraits Class Reference

#include <Gi.h>

Inheritance diagram for OdGiSubEntityTraits:

Public Types
enum	DrawFlags {   kNoDrawFlags = 0x0000 , kDrawBackfaces = 0x0001 , kDrawHatchGroup = 0x0002 , kDrawFrontfacesOnly = 0x0004 ,   kDrawGradientFill = 0x0008 , kDrawSolidFill = 0x0010 , kDrawNoLineWeight = 0x0020 , kDrawNoPlotstyle = 0x0080 ,   kDrawContourFill = 0x08000 , kDisableLayoutCache = 0x10000 , kDrawBoundaryForClipping = 0x20000 , kDrawBoundaryForClippingDrw = 0x40000 ,   kClipSetIsEmpty = 0x80000 , kDrawPolygonFill = 0x100000 , kExcludeFromViewExt = 0x200000 , kDrawDgLsPolyWithoutBreaks = 0x400000 ,   kPolygonProcessing = 0x800000 , kDisableAutoGenerateNormals = 0x1000000 , kDisableFillModeCheck = 0x2000000 , kDrawUnderlayReference = 0x4000000 ,   kLineStyleScaleOverride = 0x8000000 , kDisableDisplayClipping = 0x10000000 , kRegenTypeDependent2dDraw = 0x20000000 , kInternalDrawFlags = kDisableLayoutCache | kClipSetIsEmpty | kRegenTypeDependent2dDraw ,   kDrawGeometryForExtents = 0x04000 , kFxNoFillOnSelect = 0x40000000 , kInheritableDrawFlags }
enum	LockFlags {   kNoLockFlags = 0x00000000 , kLockColors = 0x00000001 , kLockLineWeight = 0x00000002 , kLockLineType = 0x00000004 ,   kLockLineTypeScale = 0x00000008 , kLockLayer = 0x00000010 , kLockByBlockLayer = 0x00000020 , kKeepAuxDataAndLockFlags = 0x00000040 ,   kInheritableLockFlags = kLockColors | kLockLineWeight | kLockLineType | kLockLineTypeScale | kLockLayer | kKeepAuxDataAndLockFlags }
enum	ShadowFlags { kShadowsCastAndReceive = 0 , kShadowsDoesNotCast = 1 , kShadowsDoesNotReceive = 2 , kShadowsIgnore = kShadowsDoesNotCast | kShadowsDoesNotReceive }
enum	SelectionFlags {   kNoSelectionFlags = 0 , kSelectionIgnore = 1 , kHighlightingGeometry = 2 , kHiddenInHighlight = 4 ,   kFxSubentitySelection = 0x80 }
enum	SubEntityHints {   kHint2DAttributes = 1 , kHint3DAttributes = 2 , kHintAllAttributes = kHint2DAttributes | kHint3DAttributes , kHintSnapModeOn = 4 ,   kHintDefaultState = kHintAllAttributes }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiSubEntityTraits)
virtual void	setColor (OdUInt16 color)=0
virtual void	setTrueColor (const OdCmEntityColor &color)=0
virtual void	setLayer (OdDbStub *layerId)=0
virtual void	setLineType (OdDbStub *lineTypeId)=0
virtual void	setSelectionMarker (OdGsMarker selectionMarker)=0
virtual void	setFillType (OdGiFillType fillType)=0
virtual void	setFillPlane (const OdGeVector3d *pNormal=0)
virtual void	setLineWeight (OdDb::LineWeight lineWeight)=0
virtual void	setLineTypeScale (double lineTypeScale=1.0)=0
virtual void	setThickness (double thickness)=0
virtual void	setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbStub *plotStyleNameId=0)=0
virtual void	setMaterial (OdDbStub *materialId)=0
virtual void	setMapper (const OdGiMapper *pMapper)=0
virtual void	setVisualStyle (const OdDbStub *visualStyleId)
virtual void	setTransparency (const OdCmTransparency &transparency)
virtual void	setDrawFlags (OdUInt32 drawFlags)
virtual void	setLockFlags (OdUInt32 lockFlags)
virtual void	setSelectionGeom (bool bSelectionFlag)
virtual void	setShadowFlags (ShadowFlags shadowFlags)
virtual void	setSectionable (bool bSectionableFlag)
virtual void	setSelectionFlags (SelectionFlags selectionFlags)
virtual OdUInt16	color () const =0
virtual OdCmEntityColor	trueColor () const =0
virtual OdDbStub *	layer () const =0
virtual OdDbStub *	lineType () const =0
virtual OdGiFillType	fillType () const =0
virtual bool	fillPlane (OdGeVector3d &normal)
virtual OdDb::LineWeight	lineWeight () const =0
virtual double	lineTypeScale () const =0
virtual double	thickness () const =0
virtual OdDb::PlotStyleNameType	plotStyleNameType () const =0
virtual OdDbStub *	plotStyleNameId () const =0
virtual OdDbStub *	material () const =0
virtual const OdGiMapper *	mapper () const =0
virtual OdDbStub *	visualStyle () const
virtual OdCmTransparency	transparency () const
virtual OdUInt32	drawFlags () const
virtual OdUInt32	lockFlags () const
virtual bool	selectionGeom () const
virtual ShadowFlags	shadowFlags () const
virtual bool	sectionable () const
virtual SelectionFlags	selectionFlags () const
virtual void	setSecondaryTrueColor (const OdCmEntityColor &color)
virtual OdCmEntityColor	secondaryTrueColor () const
virtual void	setLineStyleModifiers (const OdGiDgLinetypeModifiers *pLSMod)
virtual const OdGiDgLinetypeModifiers *	lineStyleModifiers () const
virtual void	setFill (const OdGiFill *pFill)
virtual const OdGiFill *	fill () const
virtual void	setAuxData (const OdGiAuxiliaryDataPtr &pAuxData)
virtual OdGiAuxiliaryDataPtr	auxData () const
virtual bool	pushLineweightOverride (const OdGiLineweightOverride *pOverride)
virtual void	popLineweightOverride ()
virtual bool	pushPaletteOverride (const OdGiPalette *pOverride)
virtual void	popPaletteOverride ()
virtual OdUInt32	setupForEntity () const
virtual void	addLight (const OdDbStub *lightId)
Public Member Functions inherited from OdGiDrawableTraits
	ODRX_DECLARE_MEMBERS (OdGiDrawableTraits)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () 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 OdRxClass *	desc ()

Detailed Description

This class provides an interface to the graphical attributes of graphic primitives.

Remarks

An OdGiSubEntityTraits instance is available during calls to subWorldDraw and subViewportDraw, so that drawable classes can control attributes during the vectorization process. Graphical attribute settings are used for all graphical primitives until they are changed.

The functions in this class are implemented by the OdGiAbstractVectorizer class.

See also

TD_Gi

<group OdGi_Classes>

Definition at line 95 of file Gi.h.

Member Enumeration Documentation

DrawFlags

enum OdGiSubEntityTraits::DrawFlags

Represents valid bitmasks that are passed to the setDrawFlags() method calls.

Enumerator
kNoDrawFlags
kDrawBackfaces
kDrawHatchGroup
kDrawFrontfacesOnly
kDrawGradientFill
kDrawSolidFill
kDrawNoLineWeight
kDrawNoPlotstyle
kDrawContourFill
kDisableLayoutCache
kDrawBoundaryForClipping
kDrawBoundaryForClippingDrw
kClipSetIsEmpty
kDrawPolygonFill
kExcludeFromViewExt
kDrawDgLsPolyWithoutBreaks
kPolygonProcessing
kDisableAutoGenerateNormals
kDisableFillModeCheck
kDrawUnderlayReference
kLineStyleScaleOverride
kDisableDisplayClipping
kRegenTypeDependent2dDraw
kInternalDrawFlags
kDrawGeometryForExtents
kFxNoFillOnSelect
kInheritableDrawFlags

Definition at line 102 of file Gi.h.

LockFlags

enum OdGiSubEntityTraits::LockFlags

Represents bitmask lock flags.

Enumerator
kNoLockFlags
kLockColors
kLockLineWeight
kLockLineType
kLockLineTypeScale
kLockLayer
kLockByBlockLayer
kKeepAuxDataAndLockFlags
kInheritableLockFlags

Definition at line 159 of file Gi.h.

SelectionFlags

enum OdGiSubEntityTraits::SelectionFlags

Represents selection flags.

Enumerator
kNoSelectionFlags
kSelectionIgnore
kHighlightingGeometry
kHiddenInHighlight
kFxSubentitySelection

Definition at line 186 of file Gi.h.

ShadowFlags

enum OdGiSubEntityTraits::ShadowFlags

Represents shadow flags.

Enumerator
kShadowsCastAndReceive
kShadowsDoesNotCast
kShadowsDoesNotReceive
kShadowsIgnore

Definition at line 175 of file Gi.h.

SubEntityHints

enum OdGiSubEntityTraits::SubEntityHints

Represents flags that hint which attributes to set.

Enumerator
kHint2DAttributes
kHint3DAttributes
kHintAllAttributes
kHintSnapModeOn
kHintDefaultState

Definition at line 201 of file Gi.h.

Member Function Documentation

addLight()

virtual void OdGiSubEntityTraits::addLight ( const OdDbStub *  lightId )

virtual

Adds a light object to the model.

Parameters

lightId

[in] Object ID of the light.

Remarks

Through this interface, drawables that emit light can add light objects to the model.

See also

<link tv_working_with_lights, Work with Lights>

Reimplemented in OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

auxData()

virtual OdGiAuxiliaryDataPtr OdGiSubEntityTraits::auxData ( ) const

virtual

Retrieves pointer to auxiliary data context.

Returns

smart pointer to the auxiliary data context object.

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

color()

virtual OdUInt16 OdGiSubEntityTraits::color ( ) const

pure virtual

Retrieves the current color index (ACI).

Returns

Color index as OdUInt16 value.

Remarks

color() returns one of the following:

Value Description kACIbyBlock 0 ByBlock. kACIforeground 7 Foreground color. kACIbyLayer 256 ByLayer. kACIRed 1 Red. kACIYellow 2 Yellow. kACIGreen 3 Green. kACICyan 4 Cyan. kACIBlue 5 Blue. kACIMagenta 6 Magenta. .. 8-255 Defined by AcadPalette.h

See also

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

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiSubEntityTraits_.

drawFlags()

virtual OdUInt32 OdGiSubEntityTraits::drawFlags ( ) const

virtual

Retrieves the current DrawFlags bitmask.

Returns

Draw bit flags as the OdUInt32 value.

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

fill()

virtual const OdGiFill * OdGiSubEntityTraits::fill ( ) const

virtual

Retrieves boundary filling parameters.

Returns

pointer to the instance of the OdGiFill class.

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

fillPlane()

virtual bool OdGiSubEntityTraits::fillPlane ( OdGeVector3d &  normal )

virtual

Retrieves the normal to the current fill plane.

Parameters

normal

[out] Receives the normal.

Returns

false in the current implementation.

Remarks

As implemented, this function does nothing but return false. It will be fully implemented in a future release.

Reimplemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

fillType()

virtual OdGiFillType OdGiSubEntityTraits::fillType ( ) const

pure virtual

Retrieves the current fill type.

Returns

One of the following values:

Value Description kOdGiFillAlways 1 Fill closed graphic primitives. kOdGiFillNever 2 Don't fill closed graphic primitives.

Closed graphic primitives consist of the following: arcs with (OdGiArcType == kOdGiArcSector) || (OdGiArcType == kOdGiArcChord) circles meshes polygons shells

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

layer()

virtual OdDbStub * OdGiSubEntityTraits::layer ( ) const

pure virtual

Retrieves the current layer.

Returns

Pointer to the OdDbStub that represents layer identifier.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

lineStyleModifiers()

virtual const OdGiDgLinetypeModifiers * OdGiSubEntityTraits::lineStyleModifiers ( ) const

virtual

Retrieves pointer to the current Dgn Line Style modifiers structure.

Returns

pointer to the OdGiDgLinetypeModifiers.

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

lineType()

virtual OdDbStub * OdGiSubEntityTraits::lineType ( ) const

pure virtual

Retrieves the current linetype.

Returns

Pointer to the OdDbStub that represents linetype identifier.

See also

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

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

lineTypeScale()

virtual double OdGiSubEntityTraits::lineTypeScale ( ) const

pure virtual

Retrieves the current linetype scale.

Returns

Linetype scale as a value of the double type.

See also

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

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

lineWeight()

virtual OdDb::LineWeight OdGiSubEntityTraits::lineWeight ( ) const

pure virtual

Retrieves the current lineweight.

Returns

Current lineweight as an OdDb::LineWeight value.

See also

<link tv_working_with_attributes_lineweights, Work with Lineweights>

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

lockFlags()

virtual OdUInt32 OdGiSubEntityTraits::lockFlags ( ) const

virtual

Retrieves the current LockFlags bitmask.

Returns

Lock bit flags as the OdUInt32 value.

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

mapper()

virtual const OdGiMapper * OdGiSubEntityTraits::mapper ( ) const

pure virtual

Retrieves pointer to the current material mapper.

Returns

Pointer to the OdDbStub that represents a mapper identifier.

See also

<link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

material()

virtual OdDbStub * OdGiSubEntityTraits::material ( ) const

pure virtual

Retrieves the identifier of the material.

Returns

Pointer to the OdDbStub that represents a material identifier.

See also

<link tv_working_with_attributes_materials, Work with Materials>

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

ODRX_DECLARE_MEMBERS()

OdGiSubEntityTraits::ODRX_DECLARE_MEMBERS

(

OdGiSubEntityTraits

)

plotStyleNameId()

virtual OdDbStub * OdGiSubEntityTraits::plotStyleNameId ( ) const

pure virtual

Retrieves object ID of the the plot style name.

Returns

Pointer to the OdDbStub that represents a plot style name identifier.

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

plotStyleNameType()

virtual OdDb::PlotStyleNameType OdGiSubEntityTraits::plotStyleNameType ( ) const

pure virtual

Retrieves the current PlotStyleName type.

Returns

One of the following values:

Value
kPlotStyleNameByLayer 0 kPlotStyleNameByBlock 1 kPlotStyleNameIsDictDefault 2 kPlotStyleNameById 3

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

popLineweightOverride()

virtual void OdGiSubEntityTraits::popLineweightOverride ( )

virtual

Pops lineweight scale and style override from lineweight overrides stack.

Reimplemented in OdGiBaseVectorizerImpl.

popPaletteOverride()

virtual void OdGiSubEntityTraits::popPaletteOverride ( )

virtual

Pop palette override from palette overrides stack.

Reimplemented in OdGiBaseVectorizerImpl, and OdGsBaseVectorizer.

pushLineweightOverride()

virtual bool OdGiSubEntityTraits::pushLineweightOverride ( const OdGiLineweightOverride *  pOverride )

virtual

Pushes lineweight scale and style override into lineweight overrides stack.

Parameters

pOverride

[in] New lineweight override.

Returns

true in case if lineweight overrides supported by underlying vectorization pipeline.

Reimplemented in OdGiBaseVectorizerImpl.

pushPaletteOverride()

virtual bool OdGiSubEntityTraits::pushPaletteOverride ( const OdGiPalette *  pOverride )

virtual

Push palette override into palette overrides stack.

Parameters

pOverride

[in] New palette override.

Returns

Returns true in case if palette overrides supported by underlying vectorization pipeline.

Reimplemented in OdGiBaseVectorizerImpl, and OdGsBaseVectorizer.

secondaryTrueColor()

virtual OdCmEntityColor OdGiSubEntityTraits::secondaryTrueColor ( ) const

virtual

Retrieves the current secondary color.

Returns

Secondary color as an instance of the OdCmEntityColor class.

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

sectionable()

virtual bool OdGiSubEntityTraits::sectionable ( ) const

virtual

Retrieves the current sectionable flag.

Returns

true if geometry is the sectionable flag is used, false otherwise.

See also

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

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

selectionFlags()

virtual SelectionFlags OdGiSubEntityTraits::selectionFlags ( ) const

virtual

Retrieves the current SelectionFlags.

Returns

One of the SelectionFlags enumeration values.

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

selectionGeom()

virtual bool OdGiSubEntityTraits::selectionGeom ( ) const

virtual

Retrieves the current selection geometry flag.

Returns

true if the selection geometry flag is used, false otherwise.

See also

<link tv_working_with_features_selections, Work with Selections>

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

setAuxData()

virtual void OdGiSubEntityTraits::setAuxData ( const OdGiAuxiliaryDataPtr &  pAuxData )

virtual

Sets pointer to auxiliary data context.

Parameters

pAuxData

[in] pointer to auxiliary data context.

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

setColor()

virtual void OdGiSubEntityTraits::setColor ( OdUInt16  color )

pure virtual

Sets the current color index (ACI).

Parameters

color

[in] Color index.

Remarks

color must be one of the following:

Value Description kACIbyBlock 0 ByBlock. kACIforeground 7 Foreground color. kACIbyLayer 256 ByLayer. kACIRed 1 Red. kACIYellow 2 Yellow. kACIGreen 3 Green. kACICyan 4 Cyan. kACIBlue 5 Blue. kACIMagenta 6 Magenta. .. 8-255 Defined by AcadPalette.h

See also

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

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiLayerTraitsTaker, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setDrawFlags()

virtual void OdGiSubEntityTraits::setDrawFlags ( OdUInt32  drawFlags )

virtual

Sets the drawing flags.

Parameters

drawFlags

[in] Input bitmask with DrawFlags.

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

setFill()

virtual void OdGiSubEntityTraits::setFill ( const OdGiFill *  pFill )

virtual

Sets boundary filling.

Parameters

pFill

[in] Boundary filling parameters.

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setFillPlane()

virtual void OdGiSubEntityTraits::setFillPlane ( const OdGeVector3d *  pNormal = 0 )

virtual

Sets the current fill plane.

Parameters

pNormal

[in] Pointer to the normal to the plane.

Remarks

As implemented, this function does nothing but return. It will be fully implemented in a future release.

Reimplemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiBaseVectorizerImpl.

setFillType()

virtual void OdGiSubEntityTraits::setFillType ( OdGiFillType  fillType )

pure virtual

Sets the current fill type.

Parameters

fillType

[in] Fill type.

Remarks

fillType must be one of the following:

Value Description kOdGiFillAlways 1 Fill closed graphic primitives. kOdGiFillNever 2 Don't fill closed graphic primitives.

Closed graphic primitives consist of the following: arcs with (OdGiArcType == kOdGiArcSector) || (OdGiArcType == kOdGiArcChord) circles meshes polygons shells

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiBaseVectorizerImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setLayer()

virtual void OdGiSubEntityTraits::setLayer ( OdDbStub *  layerId )

pure virtual

Sets the current layer.

Parameters

layerId

[in] Object ID of the LayerTableRecord.

See also

<link tv_working_with_attributes_layers, Work with Layers>

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setLineStyleModifiers()

virtual void OdGiSubEntityTraits::setLineStyleModifiers ( const OdGiDgLinetypeModifiers *  pLSMod )

virtual

Sets Dgn Line Style modifiers.

Parameters

pLSMod

[in] Pointer to structure with Dgn Line Style modifiers.

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setLineType()

virtual void OdGiSubEntityTraits::setLineType ( OdDbStub *  lineTypeId )

pure virtual

Sets the current linetype.

Parameters

lineTypeId

[in] Object ID of the LinetypeTableRecord.

See also

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

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiLayerTraitsTaker, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setLineTypeScale()

virtual void OdGiSubEntityTraits::setLineTypeScale ( double  lineTypeScale = 1.0 )

pure virtual

Sets the current linetype scale.

Parameters

lineTypeScale

[in] Linetype scale factor.

See also

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

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setLineWeight()

virtual void OdGiSubEntityTraits::setLineWeight ( OdDb::LineWeight  lineWeight )

pure virtual

Sets the current lineweight.

Parameters

lineWeight

[in] Lineweight.

See also

<link tv_working_with_attributes_lineweights, Work with Lineweights>

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiLayerTraitsTaker, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setLockFlags()

virtual void OdGiSubEntityTraits::setLockFlags ( OdUInt32  lockFlags )

virtual

Sets the lock flags.

Parameters

lockFlags

[in] Input bitmask with LockFlags.

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

setMapper()

virtual void OdGiSubEntityTraits::setMapper ( const OdGiMapper *  pMapper )

pure virtual

Sets the current material mapper.

Parameters

pMapper

[in] Pointer to the GI mapper object.

See also

<link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Implemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiWorldDrawImpl, OdGiBaseVectorizer, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

setMaterial()

virtual void OdGiSubEntityTraits::setMaterial ( OdDbStub *  materialId )

pure virtual

Sets the current material.

Parameters

materialId

[in] Object ID of the material.

See also

<link tv_working_with_attributes_materials, Work with Materials>

Implemented in OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiWorldDrawImpl, OdGiBaseVectorizer, and OdGiLayerTraitsTaker.

setPlotStyleName()

virtual void OdGiSubEntityTraits::setPlotStyleName ( OdDb::PlotStyleNameType  plotStyleNameType, OdDbStub *  plotStyleNameId = 0  )

pure virtual

Sets the current PlotStyleName.

Parameters

plotStyleNameType	[in] Plot Style Name Type.
plotStyleNameId	[in] Object ID of the Plot Style Name.

Remarks

plotStyleNameId is used only when plotStyleNameType == kPlotStyleNameById.

plotStyleNameType must be one of the following:

Value
kPlotStyleNameByLayer 0 kPlotStyleNameByBlock 1 kPlotStyleNameIsDictDefault 2 kPlotStyleNameById 3

Implemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

setSecondaryTrueColor()

virtual void OdGiSubEntityTraits::setSecondaryTrueColor ( const OdCmEntityColor &  color )

virtual

Sets the current secondary color from an OdCmEntityColor instance.

Parameters

color

[in] OdCmEntityColor object.

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setSectionable()

virtual void OdGiSubEntityTraits::setSectionable ( bool  bSectionableFlag )

virtual

Sets sectionable flag.

Parameters

bSectionableFlag

[in] New sectionable flag.

See also

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

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

setSelectionFlags()

virtual void OdGiSubEntityTraits::setSelectionFlags ( SelectionFlags  selectionFlags )

virtual

Sets the selection flags.

Parameters

selectionFlags

[in] Input SelectionFlags.

Reimplemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiWorldDrawImpl, and OdGiBaseVectorizer.

setSelectionGeom()

virtual void OdGiSubEntityTraits::setSelectionGeom ( bool  bSelectionFlag )

virtual

Sets selection geometry flag.

Parameters

bSelectionFlag

[in] New selection geometry flag.

See also

<link tv_working_with_features_selections, Work with Selections>

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

setSelectionMarker()

virtual void OdGiSubEntityTraits::setSelectionMarker ( OdGsMarker  selectionMarker )

pure virtual

Sets the current selection marker.

Parameters

marker

[in] Selection marker.

Implemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGsBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, and OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >.

setShadowFlags()

virtual void OdGiSubEntityTraits::setShadowFlags ( ShadowFlags  shadowFlags )

virtual

Sets the shadow flags.

Parameters

shadowFlags

[in] Input ShadowFlags.

See also

<link gi_shadows_rendering, Shadows Visualization>

Reimplemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiWorldDrawImpl, and OdGiBaseVectorizer.

setThickness()

virtual void OdGiSubEntityTraits::setThickness ( double  thickness )

pure virtual

Sets the current thickness.

Parameters

thickness

[in] Thickness.

Implemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiWorldDrawImpl, OdGiBaseVectorizer, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

setTransparency()

virtual void OdGiSubEntityTraits::setTransparency ( const OdCmTransparency &  transparency )

virtual

Sets the current transparency.

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>

Reimplemented in OdGiWorldDrawImpl, OdGiBaseVectorizer, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

setTrueColor()

virtual void OdGiSubEntityTraits::setTrueColor ( const OdCmEntityColor &  color )

pure virtual

Sets the current color from an OdCmEntityColor instance.

Parameters

color

[in] OdCmEntityColor object.

See also

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

Implemented in OdGiWorldDrawImpl, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, OdGiLayerTraitsTaker, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, and OdGiBaseVectorizer.

setupForEntity()

virtual OdUInt32 OdGiSubEntityTraits::setupForEntity ( ) const

virtual

Retrieves the set of SubEntityHints flags which can be used to provide more flexible tuning of subSetAttributes traits processing.

Returns

SubEntityHints flags as the OdUInt32 value.

Reimplemented in OdGiBaseVectorizerImpl.

setVisualStyle()

virtual void OdGiSubEntityTraits::setVisualStyle ( const OdDbStub *  visualStyleId )

virtual

Sets the current visual style.

Parameters

visualStyleId

[in] Object ID of the visual style.

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Reimplemented in OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiBaseVectorizer, OdGiWorldDrawImpl, and OdGiDummySubEntityTraits< OdGiSubEntityTraits >.

shadowFlags()

virtual ShadowFlags OdGiSubEntityTraits::shadowFlags ( ) const

virtual

Retrieves the current ShadowFlags.

Returns

One of the ShadowFlags enumeration values.

See also

<link gi_shadows_rendering, Shadows Visualization>

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

thickness()

virtual double OdGiSubEntityTraits::thickness ( ) const

pure virtual

Retrieves the current thickness.

Returns

Current thickness as a value of the double type.

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

transparency()

virtual OdCmTransparency OdGiSubEntityTraits::transparency ( ) const

virtual

Retrieves the current transparency.

Returns

Transparency as an instance of the OdCmTransparency class.

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>

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

trueColor()

virtual OdCmEntityColor OdGiSubEntityTraits::trueColor ( ) const

pure virtual

Retrieves the current color.

Returns

Current color as an OdCmEntityColor instance.

Color index as OdUInt16 value.

See also

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

Implemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiDummySubEntityTraits< OdGiSubEntityTraits >, and OdGiLayerTraitsTaker.

visualStyle()

virtual OdDbStub * OdGiSubEntityTraits::visualStyle ( ) const

virtual

Retrieves an identifier of the visual style.

Returns

Pointer to the OdDbStub that represents a visual style identifier.

See also

<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Reimplemented in OdGiWorldDrawImpl, OdGiSubEntityTraitsToDataWrapper< OdStaticRxObject< OdGiSubEntityTraits >, OdGiSubEntityTraitsData >, OdGiSubEntityTraitsToDataWrapper< OdGiSubEntityTraits, OdGiSubEntityTraits >, OdGiLayerTraitsTaker, and OdGiBaseVectorizerImpl.

---

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

• Gi.h