#include <GiDummyGeometry.h>

Inheritance diagram for OdGiDummySubEntityTraits< T >:

Public Member Functions
void	setColor (OdUInt16 color)

void	setTrueColor (const OdCmEntityColor &color)

void	setLayer (OdDbStub *layerId)

void	setLineType (OdDbStub *lineTypeId)

void	setSelectionMarker (OdGsMarker selectionMarker)

void	setFillType (OdGiFillType fillType)

void	setFillPlane (const OdGeVector3d *pNormal=0)

void	setLineWeight (OdDb::LineWeight lineWeight)

void	setLineTypeScale (double lineTypeScale=1.0)

void	setThickness (double thickness)

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

void	setMaterial (OdDbStub *materialId)

void	setMapper (const OdGiMapper *pMapper)

void	setVisualStyle (const 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)

OdUInt16	color () const

OdCmEntityColor	trueColor () const

OdDbStub *	layer () const

OdDbStub *	lineType () const

OdGiFillType	fillType () const

bool	fillPlane (OdGeVector3d &normal)

OdDb::LineWeight	lineWeight () const

double	lineTypeScale () const

double	thickness () const

OdDb::PlotStyleNameType	plotStyleNameType () const

OdDbStub *	plotStyleNameId () const

OdDbStub *	material () const

const OdGiMapper *	mapper () const

void	addLight (const OdDbStub *)

OdCmTransparency	transparency () const

OdUInt32	drawFlags () const

OdUInt32	lockFlags () const

bool	selectionGeom () const

OdGiSubEntityTraits::ShadowFlags	shadowFlags () const

bool	sectionable () const

OdGiSubEntityTraits::SelectionFlags	selectionFlags () const

Detailed Description

template<class T>
class OdGiDummySubEntityTraits< T >

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 2279 of file GiDummyGeometry.h.

Member Function Documentation

◆ addLight()

template<class T >

void OdGiDummySubEntityTraits< T >::addLight ( const OdDbStub * )

inline

Adds the specified light. Does nothing in the current implementation.

See also: <link tv_working_with_lights, Work with Lights>

Definition at line 2614 of file GiDummyGeometry.h.

◆ color()

template<class T >

OdUInt16 OdGiDummySubEntityTraits< T >::color ( ) const

inline

Retrieves color index (ACI).

Returns: 0 in current implementation.

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

Definition at line 2495 of file GiDummyGeometry.h.

◆ drawFlags()

template<class T >

OdUInt32 OdGiDummySubEntityTraits< T >::drawFlags ( ) const

inline

Retrieves the current DrawFlags bitmask.

Returns: 0 in current implementation.

Definition at line 2634 of file GiDummyGeometry.h.

◆ fillPlane()

template<class T >

bool OdGiDummySubEntityTraits< T >::fillPlane ( OdGeVector3d & normal )

inline

Retrieves the current fill plane. Currently not implemented.

Parameters

normal [in] Normal to a plane.

Returns: false in current implementation.

Definition at line 2543 of file GiDummyGeometry.h.

◆ fillType()

template<class T >

OdGiFillType OdGiDummySubEntityTraits< T >::fillType ( ) const

inline

Retrieves the current linetype.

Returns: the kOdGiFillNever value in current implementation.

Definition at line 2533 of file GiDummyGeometry.h.

◆ layer()

template<class T >

OdDbStub * OdGiDummySubEntityTraits< T >::layer ( ) const

inline

Retrieves the current layer.

Returns: null pointer in current implementation.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Definition at line 2515 of file GiDummyGeometry.h.

◆ lineType()

template<class T >

OdDbStub * OdGiDummySubEntityTraits< T >::lineType ( ) const

inline

Retrieves the current linetype.

Returns: null pointer in current implementation.

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

Definition at line 2525 of file GiDummyGeometry.h.

◆ lineTypeScale()

template<class T >

double OdGiDummySubEntityTraits< T >::lineTypeScale ( ) const

inline

Retrieves the current linetype scale.

Returns: 0.0 in current implementation.

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

Definition at line 2563 of file GiDummyGeometry.h.

◆ lineWeight()

template<class T >

OdDb::LineWeight OdGiDummySubEntityTraits< T >::lineWeight ( ) const

inline

Retrieves the current lineweight.

Returns: OdDb::kLnWt000 value in current implementation.

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 2553 of file GiDummyGeometry.h.

◆ lockFlags()

template<class T >

OdUInt32 OdGiDummySubEntityTraits< T >::lockFlags ( ) const

inline

Retrieves the current LockFlags bitmask.

Returns: 0 in current implementation.

Definition at line 2642 of file GiDummyGeometry.h.

◆ mapper()

template<class T >

const OdGiMapper * OdGiDummySubEntityTraits< T >::mapper ( ) const

inline

Retrieves pointer to the current material mapper.

Returns: null pointer in current implementation.

See also: <link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Definition at line 2607 of file GiDummyGeometry.h.

◆ material()

template<class T >

OdDbStub * OdGiDummySubEntityTraits< T >::material ( ) const

inline

Retrieves the identifier of the material.

Returns: null pointer in current implementation.

See also: <link tv_working_with_attributes_materials, Work with Materials>

Definition at line 2597 of file GiDummyGeometry.h.

◆ plotStyleNameId()

template<class T >

OdDbStub * OdGiDummySubEntityTraits< T >::plotStyleNameId ( ) const

inline

Retrieves object ID of the the plot style name.

Returns: null pointer in current implementation.

Definition at line 2587 of file GiDummyGeometry.h.

◆ plotStyleNameType()

template<class T >

OdDb::PlotStyleNameType OdGiDummySubEntityTraits< T >::plotStyleNameType ( ) const

inline

Retrieves the current PlotStyleName type.

Returns: OdDb::kPlotStyleNameByBlock in current implementation.

Definition at line 2579 of file GiDummyGeometry.h.

◆ sectionable()

template<class T >

bool OdGiDummySubEntityTraits< T >::sectionable ( ) const

inline

Retrieves the current sectionable flag.

Returns: false in current implementation.

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

Definition at line 2672 of file GiDummyGeometry.h.

◆ selectionFlags()

template<class T >

OdGiSubEntityTraits::SelectionFlags OdGiDummySubEntityTraits< T >::selectionFlags ( ) const

inline

Retrieves the current SelectionFlags.

Returns: the OdGiSubEntityTraits::kNoSelectionFlags value in current implementation.

Definition at line 2680 of file GiDummyGeometry.h.

◆ selectionGeom()

template<class T >

bool OdGiDummySubEntityTraits< T >::selectionGeom ( ) const

inline

Retrieves the current selection geometry flag.

Returns: false in current implementation.

See also: <link tv_working_with_features_selections, Work with Selections>

Definition at line 2652 of file GiDummyGeometry.h.

◆ setColor()

template<class T >

void OdGiDummySubEntityTraits< T >::setColor ( OdUInt16 color )

inline

Sets the current color index (ACI). Does nothing in current implementation.

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>

Definition at line 2305 of file GiDummyGeometry.h.

◆ setDrawFlags()

template<class T >

void OdGiDummySubEntityTraits< T >::setDrawFlags ( OdUInt32 drawFlags )

inline

Sets the drawing flags. Does nothing in current implementation.

Parameters

drawFlags [in] Input bitmask with DrawFlags.

Definition at line 2444 of file GiDummyGeometry.h.

◆ setFillPlane()

template<class T >

void OdGiDummySubEntityTraits< T >::setFillPlane ( const OdGeVector3d * pNormal = 0 )

inline

Sets the current fill plane. Does nothing in current implementation.

Parameters

pNormal [in] Pointer to the normal to the plane.

Definition at line 2358 of file GiDummyGeometry.h.

◆ setFillType()

template<class T >

void OdGiDummySubEntityTraits< T >::setFillType ( OdGiFillType fillType )

inline

Sets the current fill type. Does nothing in current implementation.

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.

Definition at line 2351 of file GiDummyGeometry.h.

◆ setLayer()

template<class T >

void OdGiDummySubEntityTraits< T >::setLayer ( OdDbStub * layerId )

inline

Sets the current layer. Does nothing in current implementation.

Parameters

layerId [in] Object ID of the LayerTableRecord.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Definition at line 2322 of file GiDummyGeometry.h.

◆ setLineType()

template<class T >

void OdGiDummySubEntityTraits< T >::setLineType ( OdDbStub * lineTypeId )

inline

Sets the current linetype. Does nothing in current implementation.

Parameters

lineTypeId [in] Object ID of the LinetypeTableRecord.

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

Definition at line 2330 of file GiDummyGeometry.h.

◆ setLineTypeScale()

template<class T >

void OdGiDummySubEntityTraits< T >::setLineTypeScale ( double lineTypeScale = 1.0 )

inline

Sets the current linetype scale. Does nothing in current implementation.

Parameters

lineTypeScale [in] Linetype scale factor.

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

Definition at line 2375 of file GiDummyGeometry.h.

◆ setLineWeight()

template<class T >

void OdGiDummySubEntityTraits< T >::setLineWeight ( OdDb::LineWeight lineWeight )

inline

Sets the current lineweight. Does nothing in current implementation.

Parameters

lineWeight [in] Lineweight.

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 2367 of file GiDummyGeometry.h.

◆ setLockFlags()

template<class T >

void OdGiDummySubEntityTraits< T >::setLockFlags ( OdUInt32 lockFlags )

inline

Sets the lock flags. Does nothing in current implementation.

Parameters

lockFlags [in] Input bitmask with LockFlags.

Definition at line 2451 of file GiDummyGeometry.h.

◆ setMapper()

template<class T >

void OdGiDummySubEntityTraits< T >::setMapper ( const OdGiMapper * pMapper )

inline

Sets the current material mapper. Does nothing in current implementation.

Parameters

pMapper [in] Pointer to the GI mapper object.

See also: <link tv_working_with_attributes_materials_mapping, Work with Mapping Properties>

Definition at line 2418 of file GiDummyGeometry.h.

◆ setMaterial()

template<class T >

void OdGiDummySubEntityTraits< T >::setMaterial ( OdDbStub * materialId )

inline

Sets the current material. Does nothing in current implementation.

Parameters

materialId [in] Object ID of the material.

See also: <link tv_working_with_attributes_materials, Work with Materials>

Definition at line 2410 of file GiDummyGeometry.h.

◆ setPlotStyleName()

template<class T >

void OdGiDummySubEntityTraits< T >::setPlotStyleName	(	OdDb::PlotStyleNameType	plotStyleNameType,
		OdDbStub *	pPlotStyleNameId = `0`
	)

inline

Sets the current PlotStyleName. Does nothing in current implementation.

Parameters

plotStyleNameType	[in] Plot Style Name Type.
pPlotStyleNameId	[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

Definition at line 2402 of file GiDummyGeometry.h.

◆ setSectionable()

template<class T >

void OdGiDummySubEntityTraits< T >::setSectionable ( bool bSectionableFlag )

inline

Sets sectionable flag. Does nothing in current implementation.

Parameters

bSectionableFlag [in] New sectionable flag.

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

Definition at line 2478 of file GiDummyGeometry.h.

◆ setSelectionFlags()

template<class T >

void OdGiDummySubEntityTraits< T >::setSelectionFlags ( OdGiSubEntityTraits::SelectionFlags selectionFlags )

inline

Sets the selection flags. Does nothing in current implementation.

Parameters

selectionFlags [in] Input SelectionFlags.

Definition at line 2485 of file GiDummyGeometry.h.

◆ setSelectionGeom()

template<class T >

void OdGiDummySubEntityTraits< T >::setSelectionGeom ( bool bSelectionFlag )

inline

Sets selection geometry flag. Does nothing in current implementation.

Parameters

bSelectionFlag [in] New selection geometry flag.

See also: <link tv_working_with_features_selections, Work with Selections>

Definition at line 2460 of file GiDummyGeometry.h.

◆ setSelectionMarker()

template<class T >

void OdGiDummySubEntityTraits< T >::setSelectionMarker ( OdGsMarker selectionMarker )

inline

Sets the current selection marker. Does nothing in current implementation.

Parameters

selectionMarker [in] Selection marker.

Definition at line 2336 of file GiDummyGeometry.h.

◆ setShadowFlags()

template<class T >

void OdGiDummySubEntityTraits< T >::setShadowFlags ( OdGiSubEntityTraits::ShadowFlags shadowFlags )

inline

Sets the shadow flags. Does nothing in current implementation.

Parameters

shadowFlags [in] Input ShadowFlags.

See also: <link gi_shadows_rendering, Shadows Visualization>

Definition at line 2469 of file GiDummyGeometry.h.

◆ setThickness()

template<class T >

void OdGiDummySubEntityTraits< T >::setThickness ( double thickness )

inline

Sets the current thickness. Does nothing in current implementation.

Parameters

thickness [in] Thickness.

Definition at line 2381 of file GiDummyGeometry.h.

◆ setTransparency()

template<class T >

void OdGiDummySubEntityTraits< T >::setTransparency ( const OdCmTransparency & transparency )

inline

Sets the current transparency. Does nothing in current implementation.

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>

Definition at line 2437 of file GiDummyGeometry.h.

◆ setTrueColor()

template<class T >

void OdGiDummySubEntityTraits< T >::setTrueColor ( const OdCmEntityColor & color )

inline

Sets the current color from an OdCmEntityColor instance. Does nothing in current implementation.

Parameters

color [in] OdCmEntityColor object.

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

Definition at line 2314 of file GiDummyGeometry.h.

◆ setVisualStyle()

template<class T >

void OdGiDummySubEntityTraits< T >::setVisualStyle ( const OdDbStub * visualStyleId )

inline

Sets the current visual style. Does nothing in current implementation.

Parameters

visualStyleId [in] Object ID of the visual style.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 2426 of file GiDummyGeometry.h.

◆ shadowFlags()

template<class T >

OdGiSubEntityTraits::ShadowFlags OdGiDummySubEntityTraits< T >::shadowFlags ( ) const

inline

Retrieves the current ShadowFlags.

Returns: the OdGiSubEntityTraits::kShadowsCastAndReceive value in current implementation.

See also: <link gi_shadows_rendering, Shadows Visualization>

Definition at line 2662 of file GiDummyGeometry.h.

◆ thickness()

template<class T >

double OdGiDummySubEntityTraits< T >::thickness ( ) const

inline

Retrieves the current thickness.

Returns: 0.0 in current implementation.

Definition at line 2571 of file GiDummyGeometry.h.

◆ transparency()

template<class T >

OdCmTransparency OdGiDummySubEntityTraits< T >::transparency ( ) const

inline

Retrieves the current transparency.

Returns: a new instance of the OdCmTransparency in current implementation.

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 2626 of file GiDummyGeometry.h.

◆ trueColor()

template<class T >

OdCmEntityColor OdGiDummySubEntityTraits< T >::trueColor ( ) const

inline

Retrieves entity color.

Returns: a new instance of the OdCmEntityColor.

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

Definition at line 2505 of file GiDummyGeometry.h.

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

GiDummyGeometry.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ addLight()

◆ color()

◆ drawFlags()

◆ fillPlane()

◆ fillType()

◆ layer()

◆ lineType()

◆ lineTypeScale()

◆ lineWeight()

◆ lockFlags()

◆ mapper()

◆ material()

◆ plotStyleNameId()

◆ plotStyleNameType()

◆ sectionable()

◆ selectionFlags()

◆ selectionGeom()

◆ setColor()

◆ setDrawFlags()

◆ setFillPlane()

◆ setFillType()

◆ setLayer()

◆ setLineType()

◆ setLineTypeScale()

◆ setLineWeight()

◆ setLockFlags()

◆ setMapper()

◆ setMaterial()

◆ setPlotStyleName()

◆ setSectionable()

◆ setSelectionFlags()

◆ setSelectionGeom()

◆ setSelectionMarker()

◆ setShadowFlags()

◆ setThickness()

◆ setTransparency()

◆ setTrueColor()

◆ setVisualStyle()

◆ shadowFlags()

◆ thickness()

◆ transparency()

◆ trueColor()