OdGiEdgeStyle Class Reference

#include <GiVisualStyle.h>

Inheritance diagram for OdGiEdgeStyle:

Public Types
enum	EdgeModel { kNoEdges = 0 , kIsolines = 1 , kFacetEdges = 2 }
enum	EdgeStyle {   kNoEdgeStyle = 0 , kVisible = 1 , kSilhouette = 2 , kObscured = 4 ,   kIntersection = 8 }
enum	EdgeModifier {   kNoEdgeModifiers = 0x000 , kOverhang = 0x001 , kJitter = 0x002 , kWidth = 0x004 ,   kColor = 0x008 , kHaloGap = 0x010 , kLinetype = 0x020 , kAlwaysOnTop = 0x040 ,   kOpacity = 0x080 , kWiggle = 0x100 , kTexture = 0x200 }
enum	JitterAmount { kJitterLow = 1 , kJitterMedium = 2 , kJitterHigh = 3 }
enum	WiggleAmount { kWiggleLow = 1 , kWiggleMedium = 2 , kWiggleHigh = 3 }
enum	LineType {   kSolid = 1 , kDashed = 2 , kDotted = 3 , kShortDash = 4 ,   kMediumDash = 5 , kLongDash = 6 , kDoubleShortDash = 7 , kDoubleMediumDash = 8 ,   kDoubleLongDash = 9 , kMediumLongDash = 10 , kSparseDot = 11 }
enum	EdgeStyleApply { kDefault , kAll }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiEdgeStyle)
void	set (const OdGiEdgeStyle &style)
OdGiEdgeStyle &	operator= (const OdGiEdgeStyle &style)
bool	operator== (const OdGiEdgeStyle &style) const
virtual void	setEdgeModel (EdgeModel model)=0
virtual EdgeModel	edgeModel () const =0
virtual void	setEdgeStyles (unsigned long nStyles)=0
virtual void	setEdgeStyleFlag (EdgeStyle flag, bool bEnable)=0
virtual unsigned long	edgeStyles () const =0
virtual bool	isEdgeStyleFlagSet (EdgeStyle flag) const =0
virtual void	setIntersectionColor (const OdCmColorBase &color)=0
virtual const OdCmColorBase &	intersectionColor () const =0
virtual OdCmColorBase &	intersectionColor ()=0
virtual void	setObscuredColor (const OdCmColorBase &color)=0
virtual const OdCmColorBase &	obscuredColor () const =0
virtual OdCmColorBase &	obscuredColor ()=0
virtual void	setObscuredLinetype (LineType ltype)=0
virtual LineType	obscuredLinetype () const =0
virtual void	setIntersectionLinetype (LineType ltype)=0
virtual LineType	intersectionLinetype () const =0
virtual void	setCreaseAngle (double nAngle)=0
virtual double	creaseAngle () const =0
virtual void	setEdgeModifiers (unsigned long nModifiers)=0
virtual void	setEdgeModifierFlag (EdgeModifier flag, bool bEnable)=0
virtual unsigned long	edgeModifiers () const =0
virtual bool	isEdgeModifierFlagSet (EdgeModifier flag) const =0
virtual void	setEdgeColor (const OdCmColorBase &color, bool bEnableModifier)=0
virtual const OdCmColorBase &	edgeColor () const =0
virtual OdCmColorBase &	edgeColor ()=0
virtual void	setOpacityLevel (double nLevel, bool bEnableModifier)=0
virtual double	opacityLevel () const =0
virtual void	setEdgeWidth (int nWidth, bool bEnableModifier)=0
virtual int	edgeWidth () const =0
virtual void	setOverhangAmount (int nAmount, bool bEnableModifier)=0
virtual int	overhangAmount () const =0
virtual void	setJitterAmount (JitterAmount amount, bool bEnableModifier)=0
virtual JitterAmount	jitterAmount () const =0
virtual void	setWiggleAmount (WiggleAmount amount, bool bEnableModifier)=0
virtual WiggleAmount	wiggleAmount () const =0
virtual void	setSilhouetteColor (const OdCmColorBase &color)=0
virtual const OdCmColorBase &	silhouetteColor () const =0
virtual OdCmColorBase &	silhouetteColor ()=0
virtual void	setSilhouetteWidth (short nWidth)=0
virtual short	silhouetteWidth () const =0
virtual void	setHaloGap (int nHaloGap, bool bEnableModifier)=0
virtual int	haloGap () const =0
virtual void	setIsolines (unsigned short nIsolines)=0
virtual unsigned short	isolines () const =0
virtual void	setHidePrecision (bool bHidePrecision)=0
virtual bool	hidePrecision () const =0
virtual void	setEdgeStyleApply (EdgeStyleApply apply)=0
virtual EdgeStyleApply	edgeStyleApply () const =0
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 defines a set of visual style properties that can be applied to the edges of graphical entities.

Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 219 of file GiVisualStyle.h.

Member Enumeration Documentation

EdgeModel

enum OdGiEdgeStyle::EdgeModel

Defines the model that is used to display the edges.

Enumerator
kNoEdges
kIsolines
kFacetEdges

Definition at line 227 of file GiVisualStyle.h.

EdgeModifier

enum OdGiEdgeStyle::EdgeModifier

Defines a collection of modifiers that can be applied to edges to give them various types of effects.

Enumerator
kNoEdgeModifiers
kOverhang
kJitter
kWidth
kColor
kHaloGap
kLinetype
kAlwaysOnTop
kOpacity
kWiggle
kTexture

Definition at line 249 of file GiVisualStyle.h.

EdgeStyle

enum OdGiEdgeStyle::EdgeStyle

Defines a collection of bitflags that represent the combination of edge styles that are in effect for displaying edges.

Enumerator
kNoEdgeStyle
kVisible
kSilhouette
kObscured
kIntersection

Definition at line 237 of file GiVisualStyle.h.

EdgeStyleApply

enum OdGiEdgeStyle::EdgeStyleApply

Defines the type of geometry to which the edge styles should be applied.

Enumerator
kDefault
kAll

Definition at line 305 of file GiVisualStyle.h.

JitterAmount

enum OdGiEdgeStyle::JitterAmount

Defines a collection of jitter values that can be applied to edges.

Enumerator
kJitterLow
kJitterMedium
kJitterHigh

Definition at line 267 of file GiVisualStyle.h.

LineType

enum OdGiEdgeStyle::LineType

Defines a collection of linetypes that can be applied to edges.

Enumerator
kSolid
kDashed
kDotted
kShortDash
kMediumDash
kLongDash
kDoubleShortDash
kDoubleMediumDash
kDoubleLongDash
kMediumLongDash
kSparseDot

Definition at line 287 of file GiVisualStyle.h.

WiggleAmount

enum OdGiEdgeStyle::WiggleAmount

Defines a collection of wiggle values that can be applied to edges.

Enumerator
kWiggleLow
kWiggleMedium
kWiggleHigh

Definition at line 277 of file GiVisualStyle.h.

Member Function Documentation

creaseAngle()

virtual double OdGiEdgeStyle::creaseAngle ( ) const

pure virtual

Returns the double value that is the angle threshold (in degrees) above which a facet edge representing adjoining facets will be displayed.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

edgeColor() [1/2]

virtual const OdCmColorBase& OdGiEdgeStyle::edgeColor ( ) const

pure virtual

Returns the color of edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

edgeColor() [2/2]

virtual OdCmColorBase& OdGiEdgeStyle::edgeColor ( )

pure virtual

Returns the color of edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

edgeModel()

virtual EdgeModel OdGiEdgeStyle::edgeModel ( ) const

pure virtual

Returns the currently used edge model value for this OdGiEdgeStyle object. All model values are defined in the EdgeModel enumeration.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

edgeModifiers()

virtual unsigned long OdGiEdgeStyle::edgeModifiers ( ) const

pure virtual

Returns the collection of currently used edge modifier flags.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

edgeStyleApply()

virtual EdgeStyleApply OdGiEdgeStyle::edgeStyleApply ( ) const

pure virtual

Returns the type of geometry to which the edge style will be applied as an EdgeStyleApply value.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

edgeStyles()

virtual unsigned long OdGiEdgeStyle::edgeStyles ( ) const

pure virtual

Returns an unsigned long value that represents a collection of edge style flags in effect.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

edgeWidth()

virtual int OdGiEdgeStyle::edgeWidth ( ) const

pure virtual

Returns the edge width in pixels.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

haloGap()

virtual int OdGiEdgeStyle::haloGap ( ) const

pure virtual

Returns the halo gap amount.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

hidePrecision()

virtual bool OdGiEdgeStyle::hidePrecision ( ) const

pure virtual

Returns if hide precision is enabled or disabled.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

intersectionColor() [1/2]

virtual const OdCmColorBase& OdGiEdgeStyle::intersectionColor ( ) const

pure virtual

Returns the color of intersection edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

intersectionColor() [2/2]

virtual OdCmColorBase& OdGiEdgeStyle::intersectionColor ( )

pure virtual

Returns the color of intersection edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

intersectionLinetype()

virtual LineType OdGiEdgeStyle::intersectionLinetype ( ) const

pure virtual

Returns the linetype of intersection edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

isEdgeModifierFlagSet()

virtual bool OdGiEdgeStyle::isEdgeModifierFlagSet ( EdgeModifier  flag ) const

pure virtual

Returns whether the specified edge modifier flag is enabled.

Parameters

flag	[in] Flag to be checked whether it's enabled or disabled.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

isEdgeStyleFlagSet()

virtual bool OdGiEdgeStyle::isEdgeStyleFlagSet ( EdgeStyle  flag ) const

pure virtual

Returns whether the specified face modifier flag is enabled.

Parameters

flag	[in] Flag to be checked whether it's enabled or disabled.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

isolines()

virtual unsigned short OdGiEdgeStyle::isolines ( ) const

pure virtual

Returns the number of isolines.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

jitterAmount()

virtual JitterAmount OdGiEdgeStyle::jitterAmount ( ) const

pure virtual

Returns the amount of jitter effect as a JitterAmount value.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

obscuredColor() [1/2]

virtual const OdCmColorBase& OdGiEdgeStyle::obscuredColor ( ) const

pure virtual

Returns the color of obscured edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

obscuredColor() [2/2]

virtual OdCmColorBase& OdGiEdgeStyle::obscuredColor ( )

pure virtual

Returns the color of obscured edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

obscuredLinetype()

virtual LineType OdGiEdgeStyle::obscuredLinetype ( ) const

pure virtual

Returns the linetype of obscured edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

ODRX_DECLARE_MEMBERS()

OdGiEdgeStyle::ODRX_DECLARE_MEMBERS

(

OdGiEdgeStyle

)

opacityLevel()

virtual double OdGiEdgeStyle::opacityLevel ( ) const

pure virtual

Returns the opacity level applied to edges.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

operator=()

OdGiEdgeStyle& OdGiEdgeStyle::operator=

(

const OdGiEdgeStyle &

style

)

operator==()

bool OdGiEdgeStyle::operator==

(

const OdGiEdgeStyle &

style

)

const

overhangAmount()

virtual int OdGiEdgeStyle::overhangAmount ( ) const

pure virtual

Returns the edge overhang in pixels.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

set()

void OdGiEdgeStyle::set

(

const OdGiEdgeStyle &

style

)

Sets a specified edge style value for this OdGiEdgeStyle object.

Parameters

style

[in] Reference to an OdGiEdgeStyle value to be copied into this edge style.

setCreaseAngle()

virtual void OdGiEdgeStyle::setCreaseAngle ( double  nAngle )

pure virtual

Sets the angle threshold, above which a facet edge representing adjoining facets will be displayed.

Parameters

nAngle

[in] Threshold angle to set.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeColor()

virtual void OdGiEdgeStyle::setEdgeColor ( const OdCmColorBase &  color, bool  bEnableModifier  )

pure virtual

Sets the color of edges.

Parameters

color	[in] Color value to set.
bEnableModifier	[in] Value that indicates whether to enable or disable the color.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeModel()

virtual void OdGiEdgeStyle::setEdgeModel ( EdgeModel  model )

pure virtual

Sets a specified edge model value for this OdGiEdgeStyle object.

Parameters

model

[in] Edge model value to set. All available values are defined in the EdgeModel enum.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeModifierFlag()

virtual void OdGiEdgeStyle::setEdgeModifierFlag ( EdgeModifier  flag, bool  bEnable  )

pure virtual

Enables or disables the specified edge modifier flag.

Parameters

flag	[in] Flag to enable or disable.
bEnable	[in] Value that indicates whether to enable or disable the specified flag.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeModifiers()

virtual void OdGiEdgeStyle::setEdgeModifiers ( unsigned long  nModifiers )

pure virtual

Sets a collection of bitflags representing the edge modifiers in effect.

Parameters

nModifiers

[in] Unsigned long value that represents a collection of bitwise flags defined in the EdgeModifier enumeration.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeStyleApply()

virtual void OdGiEdgeStyle::setEdgeStyleApply ( EdgeStyleApply  apply )

pure virtual

Sets a type to what geometry the edge style should be applied.

Parameters

apply

[in] Value that represents the type of geometry to which the edge styles should be applied.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeStyleFlag()

virtual void OdGiEdgeStyle::setEdgeStyleFlag ( EdgeStyle  flag, bool  bEnable  )

pure virtual

Enables or disables the given edge styles flag.

Parameters

flag	[in] A flag to enable or disable.
bEnable	[in] A boolean value indicating if the given flag is to be enabled or disabled.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeStyles()

virtual void OdGiEdgeStyle::setEdgeStyles ( unsigned long  nStyles )

pure virtual

Sets a combination of values from the EdgeStyle enumeration as an edge styles value for this OdGiEdgeStyle object.

Parameters

nStyles

[in] A combination of bit flags from the EdgeStyle enumeration indicating desired edge styles.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setEdgeWidth()

virtual void OdGiEdgeStyle::setEdgeWidth ( int  nWidth, bool  bEnableModifier  )

pure virtual

Sets the edge width in pixels.

Parameters

nWidth	[in] The width to set.
bEnableModifier	[in] Value that indicates whether to enable or disable the edge width.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setHaloGap()

virtual void OdGiEdgeStyle::setHaloGap ( int  nHaloGap, bool  bEnableModifier  )

pure virtual

Sets the amount of halo gap.

Parameters

nHaloGap	[in] The halo gap amount to set. Value must be from 0 to 100.
bEnableModifier	[in] Value that indicates whether to enable or disable halo gap.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setHidePrecision()

virtual void OdGiEdgeStyle::setHidePrecision ( bool  bHidePrecision )

pure virtual

Sets whether hide precision should be enabled.

Parameters

bHidePrecision

[in] Value that indicates whether to enable or disable hide precision.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setIntersectionColor()

virtual void OdGiEdgeStyle::setIntersectionColor ( const OdCmColorBase &  color )

pure virtual

Sets the color of intersection edges.

Parameters

color

[in] Intersection edges color to set.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setIntersectionLinetype()

virtual void OdGiEdgeStyle::setIntersectionLinetype ( LineType  ltype )

pure virtual

Sets the linetype of intersection edges.

Parameters

ltype

[in] Intersection edges linetype to set.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setIsolines()

virtual void OdGiEdgeStyle::setIsolines ( unsigned short  nIsolines )

pure virtual

Sets the number of isolines.

Parameters

nIsolines

[in] The number of isolines to set. Value must be between 0 and 2047.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setJitterAmount()

virtual void OdGiEdgeStyle::setJitterAmount ( JitterAmount  amount, bool  bEnableModifier  )

pure virtual

Sets the amount of jitter effect to be applied to jittered edges.

Parameters

amount	[in] The jitter amount to set. All applicable values are defined in the JitterAmount enumeration.
bEnableModifier	[in] Value that indicates whether to enable or disable jitter effect.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setObscuredColor()

virtual void OdGiEdgeStyle::setObscuredColor ( const OdCmColorBase &  color )

pure virtual

Sets the color of obscured edges.

Parameters

color

[in] Obscured edges color to set.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setObscuredLinetype()

virtual void OdGiEdgeStyle::setObscuredLinetype ( LineType  ltype )

pure virtual

Sets the linetype of obscured edges.

Parameters

ltype

[in] Obscured edges linetype to set.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setOpacityLevel()

virtual void OdGiEdgeStyle::setOpacityLevel ( double  nLevel, bool  bEnableModifier  )

pure virtual

Sets the opacity level of edges.

Parameters

nLevel	[in] Opacity level to set. Must be in the range from 0.0 (edges are fully transparent) to 1.0 (no transparency).
bEnableModifier	[in] Value that indicates whether to enable or disable the opacity.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setOverhangAmount()

virtual void OdGiEdgeStyle::setOverhangAmount ( int  nAmount, bool  bEnableModifier  )

pure virtual

Sets the amount (in pixels) that edges should overhang their start and end points.

Parameters

nAmount	[in] The overhang amount.
bEnableModifier	[in] Value that indicates whether to enable or disable edge overhang.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setSilhouetteColor()

virtual void OdGiEdgeStyle::setSilhouetteColor ( const OdCmColorBase &  color )

pure virtual

Sets the color of silhouette edges.

Parameters

color

[in] Reference to an OdCmColorBase value to set.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setSilhouetteWidth()

virtual void OdGiEdgeStyle::setSilhouetteWidth ( short  nWidth )

pure virtual

Sets the width of silhouette edges.

Parameters

nWidth

[in] Width of silhouette edges (in pixels) to set.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

setWiggleAmount()

virtual void OdGiEdgeStyle::setWiggleAmount ( WiggleAmount  amount, bool  bEnableModifier  )

pure virtual

Sets the amount of wiggle effect to be applied to edges.

Parameters

amount	[in] The wiggle amount to set. All applicable values are defined in the WiggleAmount enumeration.
bEnableModifier	[in] Value that indicates whether to enable or disable wiggle effect.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

silhouetteColor() [1/2]

virtual const OdCmColorBase& OdGiEdgeStyle::silhouetteColor ( ) const

pure virtual

Returns the silhouette color.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

silhouetteColor() [2/2]

virtual OdCmColorBase& OdGiEdgeStyle::silhouetteColor ( )

pure virtual

Returns the silhouette color.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

silhouetteWidth()

virtual short OdGiEdgeStyle::silhouetteWidth ( ) const

pure virtual

Returns the width of silhouette edges in pixels.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

wiggleAmount()

virtual WiggleAmount OdGiEdgeStyle::wiggleAmount ( ) const

pure virtual

Returns the amount of wiggle effect as a WiggleAmount value.

Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.

---

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

• GiVisualStyle.h