CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
OdGsStateBranch Class Reference

#include <GsHighlightData.h>

Public Types

enum  BranchType { kHighlightingBranch , kVisibilityBranch , kTransformationBranch , kNumBranchTypes }
 

Public Member Functions

 OdGsStateBranch (const OdDbStub *pDrawableId, BranchType branchType)
 
 OdGsStateBranch (const OdGiDrawable *pTransDrawable, BranchType branchType)
 
void addRef ()
 
bool release ()
 
const OdGsStateBranchPtrArray & aChild () const
 
const OdGsMarkerSet & markers () const
 
OdUInt32 markersSize () const
 
bool markersEmpty () const
 
OdGsStateBranch * addChild (OdDbStub *pDrawableId)
 
OdGsStateBranch * addChild (const OdGiDrawable *pTransDrawable)
 
void removeChild (const OdGsStateBranch *pChild)
 
OdGsStateBranch * findChild (const OdDbStub *pDrawableId) const
 
OdGsStateBranch * findChild (const OdGiDrawable *pTransDrawable) const
 
bool addMarker (OdGsMarker marker, const OdGsSimpleParam *pData=NULL, bool bDiffParamSet=false)
 
bool removeMarker (OdGsMarker marker)
 
bool hasMarker (OdGsMarker marker) const
 
bool hasMarker (OdGsMarker marker, OdGsMarkerSet::const_iterator &itRev) const
 
const OdDbStub * id () const
 
const OdGiDrawable * drw () const
 
bool isEmpty () const
 
bool isPersistentId () const
 
BranchType type () const
 
void setNextTypeOfBranch (OdGsStateBranch *pNext)
 
OdGsStateBranch * nextTypeOfBranch ()
 
const OdGsStateBranch * nextTypeOfBranch () const
 
void setReactor (OdGsStateBranchReactor *pReactor)
 
OdGsStateBranchReactor * reactor ()
 
bool setData (const OdGsSimpleParam *pData)
 
void resetData ()
 
const OdGsSimpleParam * data () const
 
bool hasData () const
 
const OdGsSimpleParam * markerData (OdGsMarker marker, OdGsMarkerSet::const_iterator *itRev=nullptr) const
 
bool hasMarkerData (OdGsMarker marker, OdGsMarkerSet::const_iterator *itRev=nullptr) const
 
OdUInt32 dataAsInt () const
 
OdUInt32 markerDataAsInt (OdGsMarker marker, OdGsMarkerSet::const_iterator *itRev=nullptr) const
 
const OdGeMatrix3d & dataAsMatrix () const
 
const OdGeMatrix3d & markerDataAsMatrix (OdGsMarker marker, OdGsMarkerSet::const_iterator *itRev=nullptr) const
 

Static Public Member Functions

static OdGsStateBranchPtr create (OdDbStub *pDrawableId, BranchType branchType, OdGsMarker marker=kNullSubentIndex, const OdGsSimpleParam *pData=NULL)
 
static OdGsStateBranchPtr create (OdGiDrawable *pTransDrawable, BranchType branchType, OdGsMarker marker=kNullSubentIndex, const OdGsSimpleParam *pData=NULL)
 
static void destroy (OdGsStateBranch *pStateBranch)
 
static bool isValidMarker (OdGsMarker marker)
 

Protected Types

enum  Flags { kPersistentId = (1 << 0) }
 

Protected Member Functions

 ODRX_HEAP_OPERATORS ()
 
 ~OdGsStateBranch ()
 
OdGsStateBranchPtrArray::iterator findChildImp (const OdDbStub *pDrawableId) const
 
OdGsStateBranchPtrArray::iterator findChildImp (const OdGiDrawable *pTransDrawable) const
 
OdGsMarkerSet & initCheckMarkers () const
 
void destroyCheckMarkers ()
 

Protected Attributes

OdRefCounter m_nRefCounter
 
OdUInt16 m_flags
 
OdUInt16 m_type
 
const void * m_pDrawableId
 
OdGsSimpleParamPtr m_pData
 
OdGsStateBranchReactorPtr m_pReactor
 
OdGsStateBranchPtr m_pNext
 
OdGsMarkerSet * m_pSetMarkers
 
OdGsStateBranchPtrArray m_aChild
 

Detailed Description

This class is a service class to keep information about highlighted subentities and nested entities on OsGsEntityNode.

Corresponding C++ library: TD_Gs

<group OdGs_Classes>

Definition at line 57 of file GsHighlightData.h.

Member Enumeration Documentation

◆ BranchType

enum OdGsStateBranch::BranchType

Type of state branch.

Enumerator
kHighlightingBranch 
kVisibilityBranch 
kTransformationBranch 
kNumBranchTypes 

Definition at line 63 of file GsHighlightData.h.

◆ Flags

enum OdGsStateBranch::Flags
protected
Enumerator
kPersistentId 

Definition at line 79 of file GsHighlightData.h.

Constructor & Destructor Documentation

◆ ~OdGsStateBranch()

OdGsStateBranch::~OdGsStateBranch ( )
inlineprotected

Definition at line 73 of file GsHighlightData.h.

◆ OdGsStateBranch() [1/2]

OdGsStateBranch::OdGsStateBranch ( const OdDbStub * pDrawableId,
BranchType branchType )
inline

Definition at line 97 of file GsHighlightData.h.

◆ OdGsStateBranch() [2/2]

OdGsStateBranch::OdGsStateBranch ( const OdGiDrawable * pTransDrawable,
BranchType branchType )
inline

Definition at line 106 of file GsHighlightData.h.

Member Function Documentation

◆ aChild()

const OdGsStateBranchPtrArray & OdGsStateBranch::aChild ( ) const
inline

Definition at line 138 of file GsHighlightData.h.

◆ addChild() [1/2]

OdGsStateBranch * OdGsStateBranch::addChild ( const OdGiDrawable * pTransDrawable)

◆ addChild() [2/2]

OdGsStateBranch * OdGsStateBranch::addChild ( OdDbStub * pDrawableId)

◆ addMarker()

bool OdGsStateBranch::addMarker ( OdGsMarker marker,
const OdGsSimpleParam * pData = NULL,
bool bDiffParamSet = false )

◆ addRef()

void OdGsStateBranch::addRef ( )
inline

Definition at line 122 of file GsHighlightData.h.

◆ create() [1/2]

static OdGsStateBranchPtr OdGsStateBranch::create ( OdDbStub * pDrawableId,
BranchType branchType,
OdGsMarker marker = kNullSubentIndex,
const OdGsSimpleParam * pData = NULL )
static

◆ create() [2/2]

static OdGsStateBranchPtr OdGsStateBranch::create ( OdGiDrawable * pTransDrawable,
BranchType branchType,
OdGsMarker marker = kNullSubentIndex,
const OdGsSimpleParam * pData = NULL )
static

◆ data()

const OdGsSimpleParam * OdGsStateBranch::data ( ) const
inline

Definition at line 188 of file GsHighlightData.h.

◆ dataAsInt()

OdUInt32 OdGsStateBranch::dataAsInt ( ) const
inline

Definition at line 243 of file GsHighlightData.h.

◆ dataAsMatrix()

const OdGeMatrix3d & OdGsStateBranch::dataAsMatrix ( ) const
inline

Definition at line 257 of file GsHighlightData.h.

◆ destroy()

static void OdGsStateBranch::destroy ( OdGsStateBranch * pStateBranch)
static

◆ destroyCheckMarkers()

void OdGsStateBranch::destroyCheckMarkers ( )
inlineprotected

Definition at line 278 of file GsHighlightData.h.

◆ drw()

const OdGiDrawable * OdGsStateBranch::drw ( ) const
inline

Definition at line 162 of file GsHighlightData.h.

◆ findChild() [1/2]

OdGsStateBranch * OdGsStateBranch::findChild ( const OdDbStub * pDrawableId) const

◆ findChild() [2/2]

OdGsStateBranch * OdGsStateBranch::findChild ( const OdGiDrawable * pTransDrawable) const

◆ findChildImp() [1/2]

OdGsStateBranchPtrArray::iterator OdGsStateBranch::findChildImp ( const OdDbStub * pDrawableId) const
protected

◆ findChildImp() [2/2]

OdGsStateBranchPtrArray::iterator OdGsStateBranch::findChildImp ( const OdGiDrawable * pTransDrawable) const
protected

◆ hasData()

bool OdGsStateBranch::hasData ( ) const
inline

Definition at line 189 of file GsHighlightData.h.

◆ hasMarker() [1/2]

bool OdGsStateBranch::hasMarker ( OdGsMarker marker) const

◆ hasMarker() [2/2]

bool OdGsStateBranch::hasMarker ( OdGsMarker marker,
OdGsMarkerSet::const_iterator & itRev ) const

◆ hasMarkerData()

bool OdGsStateBranch::hasMarkerData ( OdGsMarker marker,
OdGsMarkerSet::const_iterator * itRev = nullptr ) const

◆ id()

const OdDbStub * OdGsStateBranch::id ( ) const
inline

Definition at line 158 of file GsHighlightData.h.

◆ initCheckMarkers()

OdGsMarkerSet & OdGsStateBranch::initCheckMarkers ( ) const
inlineprotected

Definition at line 271 of file GsHighlightData.h.

◆ isEmpty()

bool OdGsStateBranch::isEmpty ( ) const
inline

Definition at line 166 of file GsHighlightData.h.

◆ isPersistentId()

bool OdGsStateBranch::isPersistentId ( ) const
inline

Definition at line 172 of file GsHighlightData.h.

◆ isValidMarker()

static bool OdGsStateBranch::isValidMarker ( OdGsMarker marker)
inlinestatic

Definition at line 199 of file GsHighlightData.h.

◆ markerData()

const OdGsSimpleParam * OdGsStateBranch::markerData ( OdGsMarker marker,
OdGsMarkerSet::const_iterator * itRev = nullptr ) const

◆ markerDataAsInt()

OdUInt32 OdGsStateBranch::markerDataAsInt ( OdGsMarker marker,
OdGsMarkerSet::const_iterator * itRev = nullptr ) const
inline

Definition at line 250 of file GsHighlightData.h.

◆ markerDataAsMatrix()

const OdGeMatrix3d & OdGsStateBranch::markerDataAsMatrix ( OdGsMarker marker,
OdGsMarkerSet::const_iterator * itRev = nullptr ) const
inline

Definition at line 264 of file GsHighlightData.h.

◆ markers()

const OdGsMarkerSet & OdGsStateBranch::markers ( ) const
inline

Definition at line 140 of file GsHighlightData.h.

◆ markersEmpty()

bool OdGsStateBranch::markersEmpty ( ) const
inline

Definition at line 142 of file GsHighlightData.h.

◆ markersSize()

OdUInt32 OdGsStateBranch::markersSize ( ) const
inline

Definition at line 141 of file GsHighlightData.h.

◆ nextTypeOfBranch() [1/2]

OdGsStateBranch * OdGsStateBranch::nextTypeOfBranch ( )
inline

Definition at line 178 of file GsHighlightData.h.

◆ nextTypeOfBranch() [2/2]

const OdGsStateBranch * OdGsStateBranch::nextTypeOfBranch ( ) const
inline

Definition at line 179 of file GsHighlightData.h.

◆ ODRX_HEAP_OPERATORS()

OdGsStateBranch::ODRX_HEAP_OPERATORS ( )
protected

◆ reactor()

OdGsStateBranchReactor * OdGsStateBranch::reactor ( )
inline

Definition at line 229 of file GsHighlightData.h.

◆ release()

bool OdGsStateBranch::release ( )
inline

Definition at line 126 of file GsHighlightData.h.

◆ removeChild()

void OdGsStateBranch::removeChild ( const OdGsStateBranch * pChild)

◆ removeMarker()

bool OdGsStateBranch::removeMarker ( OdGsMarker marker)

◆ resetData()

void OdGsStateBranch::resetData ( )
inline

Definition at line 187 of file GsHighlightData.h.

◆ setData()

bool OdGsStateBranch::setData ( const OdGsSimpleParam * pData)
inline

Definition at line 231 of file GsHighlightData.h.

◆ setNextTypeOfBranch()

void OdGsStateBranch::setNextTypeOfBranch ( OdGsStateBranch * pNext)
inline

Definition at line 177 of file GsHighlightData.h.

◆ setReactor()

void OdGsStateBranch::setReactor ( OdGsStateBranchReactor * pReactor)
inline

Definition at line 228 of file GsHighlightData.h.

◆ type()

BranchType OdGsStateBranch::type ( ) const
inline

Definition at line 174 of file GsHighlightData.h.

Member Data Documentation

◆ m_aChild

OdGsStateBranchPtrArray OdGsStateBranch::m_aChild
mutableprotected

Definition at line 93 of file GsHighlightData.h.

◆ m_flags

OdUInt16 OdGsStateBranch::m_flags
protected

Definition at line 85 of file GsHighlightData.h.

◆ m_nRefCounter

OdRefCounter OdGsStateBranch::m_nRefCounter
protected

Definition at line 84 of file GsHighlightData.h.

◆ m_pData

OdGsSimpleParamPtr OdGsStateBranch::m_pData
protected

Definition at line 89 of file GsHighlightData.h.

◆ m_pDrawableId

const void* OdGsStateBranch::m_pDrawableId
protected

Definition at line 87 of file GsHighlightData.h.

◆ m_pNext

OdGsStateBranchPtr OdGsStateBranch::m_pNext
protected

Definition at line 91 of file GsHighlightData.h.

◆ m_pReactor

OdGsStateBranchReactorPtr OdGsStateBranch::m_pReactor
protected

Definition at line 90 of file GsHighlightData.h.

◆ m_pSetMarkers

OdGsMarkerSet* OdGsStateBranch::m_pSetMarkers
mutableprotected

Definition at line 92 of file GsHighlightData.h.

◆ m_type

OdUInt16 OdGsStateBranch::m_type
protected

Definition at line 86 of file GsHighlightData.h.

The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:32