OdGiSelectionStyle Class Reference

#include <GiSelectionStyle.h>

Inheritance diagram for OdGiSelectionStyle:

Classes
class	ColorMask
class	EdgeStyle
class	ElementStyle
struct	GIntAccessor
class	StyleEntry
class	WrapGIntFlags

Public Types
typedef ElementStyle	FaceStyle

Public Member Functions
	OdGiSelectionStyle ()
StyleEntry &	styleFor (bool bDrawOnTop=false, bool bDrawIn3d=false)
const StyleEntry &	styleFor (bool bDrawOnTop=false, bool bDrawIn3d=false) const
void	sync3d ()
void	sync2d ()
void	exchangeTopBottom (bool bFor2d=true, bool bFor3d=true)
void	setOnTopOfDepth (bool bSet)
bool	isOnTopOfDepth () const
void	setByDefault ()
void	setAsDisabled ()
void	setForStippling ()
void	setForColorMasking ()

Protected Member Functions
int	makeEntryId (bool bDrawOnTop, bool bDrawIn3d) const

Protected Attributes
StyleEntry	m_styleEntry [4]

Detailed Description

This class represents selection style data. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 36 of file GiSelectionStyle.h.

Member Typedef Documentation

FaceStyle

typedef ElementStyle OdGiSelectionStyle::FaceStyle

Face style data.

Definition at line 257 of file GiSelectionStyle.h.

Constructor & Destructor Documentation

OdGiSelectionStyle()

OdGiSelectionStyle::OdGiSelectionStyle ( )

inline

Default constructor for the OdGiSelectionStyle class.

Definition at line 521 of file GiSelectionStyle.h.

Member Function Documentation

exchangeTopBottom()

void OdGiSelectionStyle::exchangeTopBottom ( bool bFor2d = true, bool bFor3d = true )

inline

Exchanges "draw on top" style components with scene geometry style components for specified selection style configurations.

Parameters

bFor2d	[in] Exchange components for 2d selection style.
bFor3d	[in] Exchange components for 3d selection style.

Definition at line 558 of file GiSelectionStyle.h.

isOnTopOfDepth()

bool OdGiSelectionStyle::isOnTopOfDepth ( ) const

inline

Returns current state of "draw on top of depth" flag.

Returns

true if the "draw on top of depth" flag is set, false otherwise.

Definition at line 577 of file GiSelectionStyle.h.

makeEntryId()

int OdGiSelectionStyle::makeEntryId ( bool bDrawOnTop, bool bDrawIn3d ) const

inlineprotected

Definition at line 516 of file GiSelectionStyle.h.

setAsDisabled()

void OdGiSelectionStyle::setAsDisabled ( )

inline

Disables diplay of scene geometry and all visual effects.

Definition at line 586 of file GiSelectionStyle.h.

setByDefault()

void OdGiSelectionStyle::setByDefault ( )

inline

Sets up selection style display scene geometry as is, without any visual effects.

Definition at line 582 of file GiSelectionStyle.h.

setForColorMasking()

void OdGiSelectionStyle::setForColorMasking ( )

inline

Sets up selection style for default color masking behavior. Draws semi-transparent faces and edges on top of scene geometry. Additionally enables edges width extension and rendering of 3d geometry isolines.

Definition at line 596 of file GiSelectionStyle.h.

setForStippling()

void OdGiSelectionStyle::setForStippling ( )

inline

Sets up selection style to display classing stippling pattern highlighting visual effect. Renders original object with stippling pattern. Doesn't render any geometry on top.

Definition at line 591 of file GiSelectionStyle.h.

setOnTopOfDepth()

void OdGiSelectionStyle::setOnTopOfDepth ( bool bSet )

inline

By default "draw on top" style redered on top of order, but with this flag it can be rendered on top of depth in 3d rendering modes.

Parameters

bSet	[in] New value for "draw on top of depth" flag.

Definition at line 568 of file GiSelectionStyle.h.

styleFor() [1/2]

StyleEntry & OdGiSelectionStyle::styleFor ( bool bDrawOnTop = false, bool bDrawIn3d = false )

inline

Returns editable combination of face and edge styles for specified selection style configuration.

Parameters

bDrawOnTop	[in] If set to true - returns "draw on top" selection styles, elsewhere returns scene geometry style.
bDrawIn3d	[in] If set to true - returns 3d selection style, elsewhere returns 2d selection style.

Returns

Reference to StyleEntry for specified selection style configuration.

Definition at line 530 of file GiSelectionStyle.h.

styleFor() [2/2]

const StyleEntry & OdGiSelectionStyle::styleFor ( bool bDrawOnTop = false, bool bDrawIn3d = false ) const

inline

Returns combination of face and edge styles for specified selection style configuration.

Parameters

bDrawOnTop	[in] If set to true - returns "draw on top" selection styles, elsewhere returns scene geometry style.
bDrawIn3d	[in] If set to true - returns 3d selection style, elsewhere returns 2d selection style.

Returns

Constant reference to StyleEntry for specified selection style configuration.

Definition at line 539 of file GiSelectionStyle.h.

sync2d()

void OdGiSelectionStyle::sync2d ( )

inline

Copies 3d selection style configuration into 2d selection style configuration (copies both top and bottom style components).

Definition at line 550 of file GiSelectionStyle.h.

sync3d()

void OdGiSelectionStyle::sync3d ( )

inline

Copies 2d selection style configuration into 3d selection style configuration (copies both top and bottom style components).

Definition at line 545 of file GiSelectionStyle.h.

Member Data Documentation

m_styleEntry

StyleEntry OdGiSelectionStyle::m_styleEntry[4]

protected

Definition at line 491 of file GiSelectionStyle.h.

---

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

• GiSelectionStyle.h