OdGiSelectionStyle::StyleEntry Class Reference

#include <GiSelectionStyle.h>

Public Member Functions
EdgeStyle &	edgeStyle ()
const EdgeStyle &	edgeStyle () const
FaceStyle &	faceStyle ()
const FaceStyle &	faceStyle () const
bool	isOnTopOfDepth () const
bool	isVisible () const
bool	hasEffect () const
void	setByDefault ()
void	setAsDisabled ()
void	setForStippling ()
void	setForColorMasking ()
void	setForColorMasking (const OdCmEntityColor &color, OdUInt8 transparency)
bool	operator== (const StyleEntry &secStyle) const
bool	operator!= (const StyleEntry &secStyle) const

Protected Attributes
EdgeStyle	m_edgeStyle
FaceStyle	m_faceStyle

Detailed Description

Combination of edge and face styles.

Definition at line 384 of file GiSelectionStyle.h.

Member Function Documentation

edgeStyle() [1/2]

EdgeStyle & OdGiSelectionStyle::StyleEntry::edgeStyle ( )

inline

Returns editable edge style data.

Returns

Reference to EdgeStyle.

Definition at line 395 of file GiSelectionStyle.h.

edgeStyle() [2/2]

const EdgeStyle & OdGiSelectionStyle::StyleEntry::edgeStyle ( ) const

inline

Returns edge style data.

Returns

Constant reference to EdgeStyle.

Definition at line 401 of file GiSelectionStyle.h.

faceStyle() [1/2]

FaceStyle & OdGiSelectionStyle::StyleEntry::faceStyle ( )

inline

Returns editable face style data.

Returns

Reference to EdgeStyle.

Definition at line 408 of file GiSelectionStyle.h.

faceStyle() [2/2]

const FaceStyle & OdGiSelectionStyle::StyleEntry::faceStyle ( ) const

inline

Returns face style data.

Returns

Constant reference to EdgeStyle.

Definition at line 414 of file GiSelectionStyle.h.

hasEffect()

bool OdGiSelectionStyle::StyleEntry::hasEffect ( ) const

inline

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

Returns

true in case if any type of visual effect (like color mask, for example) is applicable for current configuration of face or edge style.

Definition at line 436 of file GiSelectionStyle.h.

isOnTopOfDepth()

bool OdGiSelectionStyle::StyleEntry::isOnTopOfDepth ( ) const

inline

Checks whether edges and faces should be displayed on top of scene graphics in 3d rendering modes.

Returns

true if edges and faces should be displayed on top of scene graphics in 3d rendering modes, false otherwise.

Definition at line 421 of file GiSelectionStyle.h.

isVisible()

bool OdGiSelectionStyle::StyleEntry::isVisible ( ) const

inline

Checks whether edges or faces is visible.

Returns

true in case if edges or faces is visible, false otherwise.

Definition at line 429 of file GiSelectionStyle.h.

operator!=()

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

inline

Inequality operator for the StyleEntry class.

Parameters

secStyle

[in] Style entry to compare.

Returns

true if at least one of the following conditions fails: Edge styles are equal. Face styles are equal.

Definition at line 487 of file GiSelectionStyle.h.

operator==()

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

inline

Equality operator for the StyleEntry class.

Parameters

secStyle

[in] Style entry to compare.

Returns

true if all the following conditions are met: Edge styles are equal. Face styles are equal.

Definition at line 475 of file GiSelectionStyle.h.

setAsDisabled()

void OdGiSelectionStyle::StyleEntry::setAsDisabled ( )

inline

Disable diplaying of faces, edges and all visual effects.

Definition at line 445 of file GiSelectionStyle.h.

setByDefault()

void OdGiSelectionStyle::StyleEntry::setByDefault ( )

inline

Setup face and edge style to display geometry as is, without any visual effects.

Definition at line 441 of file GiSelectionStyle.h.

setForColorMasking() [1/2]

void OdGiSelectionStyle::StyleEntry::setForColorMasking ( )

inline

Setup face and edge styles 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 454 of file GiSelectionStyle.h.

setForColorMasking() [2/2]

void OdGiSelectionStyle::StyleEntry::setForColorMasking ( const OdCmEntityColor & color, OdUInt8 transparency )

inline

Setup face and edge styles to display color mask visual effect with specified color and transparency.

Parameters

color	[in] Color mask color value.
transparency	[in] Color mask transparency value.

Definition at line 461 of file GiSelectionStyle.h.

setForStippling()

void OdGiSelectionStyle::StyleEntry::setForStippling ( )

inline

Setup face and edge styles to display stippling pattern highlighting visual effect.

Definition at line 449 of file GiSelectionStyle.h.

Member Data Documentation

m_edgeStyle

EdgeStyle OdGiSelectionStyle::StyleEntry::m_edgeStyle

protected

Definition at line 387 of file GiSelectionStyle.h.

m_faceStyle

FaceStyle OdGiSelectionStyle::StyleEntry::m_faceStyle

protected

Definition at line 388 of file GiSelectionStyle.h.

---

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

• GiSelectionStyle.h