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

#include <GiSelectionStyle.h>

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

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 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  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 197 of file GiSelectionStyle.h.

Member Enumeration Documentation

◆ EdgeFlags

Enumerator
kDrawIsolines 
kDrawContours 

Definition at line 210 of file GiSelectionStyle.h.

◆ Mode

Edges diplaying mode.

Enumerator
kExistEdges 
kIsolineEdges 
kContourEdges 

Definition at line 203 of file GiSelectionStyle.h.

Constructor & Destructor Documentation

◆ EdgeStyle()

OdGiSelectionStyle::EdgeStyle::EdgeStyle ( )
inline

Definition at line 217 of file GiSelectionStyle.h.

Member Function Documentation

◆ hasEffect()

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

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 257 of file GiSelectionStyle.h.

◆ hasLineWeightExtension()

bool OdGiSelectionStyle::EdgeStyle::hasLineWeightExtension ( ) const
inline

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

Definition at line 251 of file GiSelectionStyle.h.

◆ lineWeightExtension()

OdInt32 OdGiSelectionStyle::EdgeStyle::lineWeightExtension ( ) const
inline

Returns current edges width extension value in pixels.

Definition at line 247 of file GiSelectionStyle.h.

◆ mode()

Mode OdGiSelectionStyle::EdgeStyle::mode ( ) const
inline

Return edges diplaying mode.

Definition at line 233 of file GiSelectionStyle.h.

◆ operator!=()

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

Definition at line 280 of file GiSelectionStyle.h.

◆ operator==()

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

Definition at line 278 of file GiSelectionStyle.h.

◆ setAsDisabled()

void OdGiSelectionStyle::EdgeStyle::setAsDisabled ( )
inline

Disable diplaying of edges and all visual effects.

Definition at line 266 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 262 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 275 of file GiSelectionStyle.h.

◆ setForStippling()

void OdGiSelectionStyle::EdgeStyle::setForStippling ( )
inline

Setup edges style to display stippling pattern highlighting visual effect.

Definition at line 270 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 243 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 223 of file GiSelectionStyle.h.

Member Data Documentation

◆ m_lineWeightExtension

OdInt32 OdGiSelectionStyle::EdgeStyle::m_lineWeightExtension
protected

Definition at line 215 of file GiSelectionStyle.h.


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