CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Attributes | List of all members
OdGiSelectionStyle::ElementStyle Class Reference

#include <GiSelectionStyle.h>

Inheritance diagram for OdGiSelectionStyle::ElementStyle:
OdGiSelectionStyle::EdgeStyle OdGiSelectionStyle::GIntAccessor

Public Member Functions

 ElementStyle ()
 
void setVisible (bool bVisible)
 
bool isVisible () const
 
void enablePattern (bool bEnable)
 
bool isPatternEnabled () const
 
void enableColorMasking (bool bEnable)
 
bool isColorMaskingEnabled () const
 
const ColorMaskcolorMask () const
 
ColorMaskcolorMask ()
 
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  ElementFlags {
  kDrawElement = (1 << 0) , kPatternElement = (1 << 1) , kMaskElement = (1 << 2) , kGOnTopOfDepth = (1 << 3) ,
  kGlobalFlags = kGOnTopOfDepth , kLastElementStyleFlag = kGOnTopOfDepth
}
 

Protected Attributes

OdUInt32 m_nFlags
 
ColorMask m_colorMask
 

Detailed Description

Basic element style data actual for edges and faces.

Definition at line 99 of file GiSelectionStyle.h.

Member Enumeration Documentation

◆ ElementFlags

Enumerator
kDrawElement 
kPatternElement 
kMaskElement 
kGOnTopOfDepth 
kGlobalFlags 
kLastElementStyleFlag 

Definition at line 102 of file GiSelectionStyle.h.

Constructor & Destructor Documentation

◆ ElementStyle()

OdGiSelectionStyle::ElementStyle::ElementStyle ( )
inline

Definition at line 116 of file GiSelectionStyle.h.

Member Function Documentation

◆ colorMask() [1/2]

ColorMask & OdGiSelectionStyle::ElementStyle::colorMask ( )
inline

Returns current color mask properties editable container.

Definition at line 155 of file GiSelectionStyle.h.

◆ colorMask() [2/2]

const ColorMask & OdGiSelectionStyle::ElementStyle::colorMask ( ) const
inline

Returns current color mask properties container.

Definition at line 151 of file GiSelectionStyle.h.

◆ enableColorMasking()

void OdGiSelectionStyle::ElementStyle::enableColorMasking ( bool  bEnable)
inline

Enables or disables application of color mask for current graphics element.

Parameters
bEnable[in] New color mask displaying state.

Definition at line 142 of file GiSelectionStyle.h.

◆ enablePattern()

void OdGiSelectionStyle::ElementStyle::enablePattern ( bool  bEnable)
inline

Enables or disables stippling pattern highlighting for current graphics element.

Parameters
bEnable[in] New stippling pattern visibility state.

Definition at line 132 of file GiSelectionStyle.h.

◆ hasEffect()

bool OdGiSelectionStyle::ElementStyle::hasEffect ( ) const
inline

Returns true in case if any type of visual effect (like stippling pattern or color mask) is applicable for current configuration of graphics element.

Definition at line 166 of file GiSelectionStyle.h.

◆ isColorMaskingEnabled()

bool OdGiSelectionStyle::ElementStyle::isColorMaskingEnabled ( ) const
inline

Returns current color mask application state for current graphics element.

Definition at line 146 of file GiSelectionStyle.h.

◆ isOnTopOfDepth()

bool OdGiSelectionStyle::ElementStyle::isOnTopOfDepth ( ) const
inline

Returns true in case if current graphics element should be displayed on top of scene graphics in 3d rendering modes.

Definition at line 160 of file GiSelectionStyle.h.

◆ isPatternEnabled()

bool OdGiSelectionStyle::ElementStyle::isPatternEnabled ( ) const
inline

Returns current stippling pattern visibility state for current graphics element.

Definition at line 136 of file GiSelectionStyle.h.

◆ isVisible()

bool OdGiSelectionStyle::ElementStyle::isVisible ( ) const
inline

Returns current visibility state of current graphics element.

Definition at line 126 of file GiSelectionStyle.h.

◆ operator!=()

bool OdGiSelectionStyle::ElementStyle::operator!= ( const ElementStyle secStyle) const
inline

Definition at line 187 of file GiSelectionStyle.h.

◆ operator==()

bool OdGiSelectionStyle::ElementStyle::operator== ( const ElementStyle secStyle) const
inline

Definition at line 185 of file GiSelectionStyle.h.

◆ setAsDisabled()

void OdGiSelectionStyle::ElementStyle::setAsDisabled ( )
inline

Disable diplaying of graphics element and all visual effects.

Definition at line 175 of file GiSelectionStyle.h.

◆ setByDefault()

void OdGiSelectionStyle::ElementStyle::setByDefault ( )
inline

Setup graphics element to display geometry as is, without any visual effects.

Definition at line 171 of file GiSelectionStyle.h.

◆ setForColorMasking()

void OdGiSelectionStyle::ElementStyle::setForColorMasking ( )
inline

Setup graphics element to display color mask visual effect with some predefined color and transparency.

Definition at line 183 of file GiSelectionStyle.h.

◆ setForStippling()

void OdGiSelectionStyle::ElementStyle::setForStippling ( )
inline

Setup graphics element to display stippling pattern highlighting visual effect.

Definition at line 179 of file GiSelectionStyle.h.

◆ setVisible()

void OdGiSelectionStyle::ElementStyle::setVisible ( bool  bVisible)
inline

Enables or disables visibility of current graphics element.

Parameters
bVisible[in] New element visibility state.

Definition at line 122 of file GiSelectionStyle.h.

Member Data Documentation

◆ m_colorMask

ColorMask OdGiSelectionStyle::ElementStyle::m_colorMask
protected

Definition at line 114 of file GiSelectionStyle.h.

◆ m_nFlags

OdUInt32 OdGiSelectionStyle::ElementStyle::m_nFlags
protected

Definition at line 113 of file GiSelectionStyle.h.


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