OdGiSelectionStyle::EdgeStyle Class Reference

#include <GiSelectionStyle.h>

Inheritance diagram for OdGiSelectionStyle::EdgeStyle:

Public Types
enum	Mode { kExistEdges , kIsolineEdges , kContourEdges }

Public Member Functions
	EdgeStyle ()
void	setMode (Mode edgeMode)
Mode	mode () const
void	setLineWeightExtension (OdInt32 nLwdExtension)
OdInt32	lineWeightExtension () const
bool	hasLineWeightExtension () const
bool	hasEffect () const
void	setByDefault ()
void	setAsDisabled ()
void	setForStippling ()
void	setForColorMasking ()
bool	operator== (const EdgeStyle &secStyle) const
bool	operator!= (const EdgeStyle &secStyle) const
Public Member Functions inherited from OdGiSelectionStyle::ElementStyle
	ElementStyle ()
void	setVisible (bool bVisible)
bool	isVisible () const
void	enablePattern (bool bEnable)
bool	isPatternEnabled () const
void	enableColorMasking (bool bEnable)
bool	isColorMaskingEnabled () const
const ColorMask &	colorMask () const
ColorMask &	colorMask ()
bool	isOnTopOfDepth () const
bool	hasEffect () const
void	setByDefault ()
void	setAsDisabled ()
void	setForStippling ()
void	setForColorMasking ()
bool	operator== (const ElementStyle &secStyle) const
bool	operator!= (const ElementStyle &secStyle) const

Protected Types
enum	EdgeFlags { kDrawIsolines = (kLastElementStyleFlag << 1) , kDrawContours = (kLastElementStyleFlag << 2) }
Protected Types inherited from OdGiSelectionStyle::ElementStyle
enum	ElementFlags {   kDrawElement = (1 << 0) , kPatternElement = (1 << 1) , kMaskElement = (1 << 2) , kGOnTopOfDepth = (1 << 3) ,   kGlobalFlags = kGOnTopOfDepth , kLastElementStyleFlag = kGOnTopOfDepth }

Protected Attributes
OdInt32	m_lineWeightExtension
Protected Attributes inherited from OdGiSelectionStyle::ElementStyle
OdUInt32	m_nFlags
ColorMask	m_colorMask

Detailed Description

Edge style data.

Definition at line 261 of file GiSelectionStyle.h.

Member Enumeration Documentation

EdgeFlags

enum OdGiSelectionStyle::EdgeStyle::EdgeFlags

protected

Enumerator
kDrawIsolines
kDrawContours

Definition at line 274 of file GiSelectionStyle.h.

Mode

enum OdGiSelectionStyle::EdgeStyle::Mode

Edges display mode.

Enumerator
kExistEdges
kIsolineEdges
kContourEdges

Definition at line 267 of file GiSelectionStyle.h.

Constructor & Destructor Documentation

EdgeStyle()

OdGiSelectionStyle::EdgeStyle::EdgeStyle ( )

inline

Default constructor for the EdgeStyle class.

Definition at line 284 of file GiSelectionStyle.h.

Member Function Documentation

hasEffect()

bool OdGiSelectionStyle::EdgeStyle::hasEffect ( ) const

inline

Checks whether any type of visual effect can be applied to a current edge style for current configuration.

Returns

true in case if any type of visual effect (like color mask or edges width) is applicable for current configuration of this edge style.

Definition at line 336 of file GiSelectionStyle.h.

hasLineWeightExtension()

bool OdGiSelectionStyle::EdgeStyle::hasLineWeightExtension ( ) const

inline

Checks whether edges width extension is enabled.

Returns

true in case if edges width extension enabled (i.e. non zero) for this edge style object.

Definition at line 328 of file GiSelectionStyle.h.

lineWeightExtension()

OdInt32 OdGiSelectionStyle::EdgeStyle::lineWeightExtension ( ) const

inline

Returns current edges width extension value in pixels.

Returns

Edges width extension in pixels.

Definition at line 321 of file GiSelectionStyle.h.

mode()

Mode OdGiSelectionStyle::EdgeStyle::mode ( ) const

inline

Return edges diplaying mode.

Returns

One of the following values: kExistEdges - Draw existing edges if they are enabled. kIsolineEdges - Draw isolines for 3d objects and existing edges for others. kContourEdges - Draw contours for 3d objects and existing edges for others.

Definition at line 305 of file GiSelectionStyle.h.

operator!=()

bool OdGiSelectionStyle::EdgeStyle::operator!= ( const EdgeStyle & secStyle ) const

inline

Inequality operator for the EdgeStyle class.

Parameters

secStyle

[in] Edge style to compare.

Returns

true if at least one of the following conditions fails: Element styles are equal. Lineweight extension value in pixels are equal.

Definition at line 378 of file GiSelectionStyle.h.

operator==()

bool OdGiSelectionStyle::EdgeStyle::operator== ( const EdgeStyle & secStyle ) const

inline

Equality operator for the EdgeStyle class.

Parameters

secStyle

[in] Edge style to compare.

Returns

true if all the following conditions are met: Element styles are equal. Lineweight extension value in pixels are equal.

Definition at line 366 of file GiSelectionStyle.h.

setAsDisabled()

void OdGiSelectionStyle::EdgeStyle::setAsDisabled ( )

inline

Disable diplaying of edges and all visual effects.

Definition at line 345 of file GiSelectionStyle.h.

setByDefault()

void OdGiSelectionStyle::EdgeStyle::setByDefault ( )

inline

Setup edges style to display edges geometry as is, without any visual effects.

Definition at line 341 of file GiSelectionStyle.h.

setForColorMasking()

void OdGiSelectionStyle::EdgeStyle::setForColorMasking ( )

inline

Setup edges style to display color mask visual effect with some predefined color and transparency. Additionally enables edges width extension and rendering of 3d geometry isolines.

Definition at line 354 of file GiSelectionStyle.h.

setForStippling()

void OdGiSelectionStyle::EdgeStyle::setForStippling ( )

inline

Setup edges style to display stippling pattern highlighting visual effect.

Definition at line 349 of file GiSelectionStyle.h.

setLineWeightExtension()

void OdGiSelectionStyle::EdgeStyle::setLineWeightExtension ( OdInt32 nLwdExtension )

inline

Sets edges width extension in pixels.

Parameters

nLwdExtension

[in] New edges width extension value.

Definition at line 315 of file GiSelectionStyle.h.

setMode()

void OdGiSelectionStyle::EdgeStyle::setMode ( Mode edgeMode )

inline

Sets edges diplaying mode.

Parameters

edgeMode

[in] New edges displaying mode.

Definition at line 290 of file GiSelectionStyle.h.

Member Data Documentation

m_lineWeightExtension

OdInt32 OdGiSelectionStyle::EdgeStyle::m_lineWeightExtension

protected

Definition at line 279 of file GiSelectionStyle.h.

---

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

• GiSelectionStyle.h