CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OdGsBaseModelReactor Class Reference

#include <GsBaseModelReactor.h>

Inheritance diagram for OdGsBaseModelReactor:
OdGsModelReactor

Public Types

enum  ModelProperty {
  kModelTransform = 0 , kModelRenderType , kModelBackground , kModelVisualStyle ,
  kModelSectioning , kNumModelProps
}
 

Public Member Functions

virtual bool onHighlight (OdGsModel *pModel, const OdGiPathNode &path, bool bDoIt, OdUInt32 &nStyle, const OdGsView *pView)
 
virtual bool onHighlight (OdGsModel *pModel, const OdGiPathNode &path, const OdGsMarker *pMarkers, OdUInt32 nMarkers, bool bDoIt, OdUInt32 &nStyle, const OdGsView *pView)
 
virtual bool onInvalidate (OdGsModel *pModel, OdGsModel::InvalidationHint hint)
 
virtual bool onInvalidate (OdGsModel *pModel, OdGsView *pView)
 
virtual bool onHide (OdGsModel *pModel, OdGsNode *pNode, bool &bHidden, bool &bSelectable, const OdGsView *pView)
 
virtual bool onHide (OdGsModel *pModel, const OdGiPathNode &path, const OdGsMarker *pMarkers, OdUInt32 nMarkers, bool &bHidden, bool &bSelectable, const OdGsView *pView)
 
virtual bool onPropertyModified (OdGsModel *pModel, ModelProperty nProp)
 
- Public Member Functions inherited from OdGsModelReactor
 OdGsModelReactor ()
 
virtual ~OdGsModelReactor ()
 
virtual bool onAdded (OdGsModel *pModel, OdGiDrawable *pAdded, OdGiDrawable *pParent)
 
virtual bool onAdded (OdGsModel *pModel, OdGiDrawable *pAdded, OdDbStub *parentID)
 
virtual bool onErased (OdGsModel *pModel, OdGiDrawable *pErased, OdGiDrawable *pParent)
 
virtual bool onErased (OdGsModel *pModel, OdGiDrawable *pErased, OdDbStub *parentID)
 
virtual bool onModified (OdGsModel *pModel, OdGiDrawable *pModified, OdGiDrawable *pParent)
 
virtual bool onModified (OdGsModel *pModel, OdGiDrawable *pModified, OdDbStub *parentID)
 
virtual bool onUnerased (OdGsModel *pModel, OdGiDrawable *pUnerased, OdGiDrawable *pParent)
 
virtual bool onUnerased (OdGsModel *pModel, OdGiDrawable *pUnerased, OdDbStub *parentID)
 

Detailed Description

GsBaseModel reactor.

Corresponding C++ library: TD_Gs <group OdGs_Classes>

Definition at line 39 of file GsBaseModelReactor.h.

Member Enumeration Documentation

◆ ModelProperty

Enumeration contains GsModel properties which changes can be handled by reactor.

Enumerator
kModelTransform 
kModelRenderType 
kModelBackground 
kModelVisualStyle 
kModelSectioning 
kNumModelProps 

Definition at line 121 of file GsBaseModelReactor.h.

Member Function Documentation

◆ onHide() [1/2]

virtual bool OdGsBaseModelReactor::onHide ( OdGsModel pModel,
const OdGiPathNode path,
const OdGsMarker pMarkers,
OdUInt32  nMarkers,
bool &  bHidden,
bool &  bSelectable,
const OdGsView pView 
)
inlinevirtual

Callback that called before GsModel changes node hidden state.

Parameters
pModel[in] Pointer to the model.
path[in] Pointer to the view.
pMarkers[in] Pointer to an array of markers.
nMarkers[in] Number of markers.
bHidden[in] Flag that shows whether model is hidden.
bSelectable[in] Flag that shows whether model is sectionable.
pView[in] Pointer to the view where the specified entity should be hidden.
Returns
true.

Definition at line 115 of file GsBaseModelReactor.h.

◆ onHide() [2/2]

virtual bool OdGsBaseModelReactor::onHide ( OdGsModel pModel,
OdGsNode pNode,
bool &  bHidden,
bool &  bSelectable,
const OdGsView pView 
)
inlinevirtual

Callback that called before GsModel changes node hidden state.

Parameters
pModel[in] Pointer to the model.
pNode[in] Pointer to the view.
bHidden[in] Flag that shows whether model is hidden.
bSelectable[in] Flag that shows whether model is sectionable.
pView[in] Pointer to the view where the specified entity should be hidden.
Returns
true.

Definition at line 102 of file GsBaseModelReactor.h.

◆ onHighlight() [1/2]

virtual bool OdGsBaseModelReactor::onHighlight ( OdGsModel pModel,
const OdGiPathNode path,
bool  bDoIt,
OdUInt32 nStyle,
const OdGsView pView 
)
inlinevirtual

Callback that is called whenever GsModel is highlighted or un-highlighted.

Parameters
pModel[in] Pointer to the model.
path[in] Path node to highlight.
bDoIt[in] Enables or disables highlighting.
nStyle[in] Selection style index.
pView[in] Pointer to the view in which model is highlighted.
Returns
true.

Definition at line 53 of file GsBaseModelReactor.h.

◆ onHighlight() [2/2]

virtual bool OdGsBaseModelReactor::onHighlight ( OdGsModel pModel,
const OdGiPathNode path,
const OdGsMarker pMarkers,
OdUInt32  nMarkers,
bool  bDoIt,
OdUInt32 nStyle,
const OdGsView pView 
)
inlinevirtual

Callback that is called whenever GsModel is highlighted or un-highlighted.

Parameters
pModel[in] Pointer to the model.
path[in] Path node to highlight.
pMarkers[in] Pointer to an array of markers.
nMarkers[in] Number of markers.
bDoIt[in] Enables or disables highlighting.
nStyle[in] Selection style index.
pView[in] Pointer to the view in which model is highlighted.
Returns
true.

Definition at line 68 of file GsBaseModelReactor.h.

◆ onInvalidate() [1/2]

virtual bool OdGsBaseModelReactor::onInvalidate ( OdGsModel pModel,
OdGsModel::InvalidationHint  hint 
)
inlinevirtual

Callback that is called whenever GsModel is marked for invalidation.

Parameters
pModel[in] Pointer to the model.
hint[in] Specifies which content of the model should be processed.
Returns
true.

Definition at line 80 of file GsBaseModelReactor.h.

◆ onInvalidate() [2/2]

virtual bool OdGsBaseModelReactor::onInvalidate ( OdGsModel pModel,
OdGsView pView 
)
inlinevirtual

Callback that is called whenever GsModel is marked for invalidation.

Parameters
pModel[in] Pointer to the model.
pView[in] Pointer to the view.
Returns
true.

Definition at line 90 of file GsBaseModelReactor.h.

◆ onPropertyModified()

virtual bool OdGsBaseModelReactor::onPropertyModified ( OdGsModel pModel,
ModelProperty  nProp 
)
inlinevirtual

Callback that called on GsModel property change.

Parameters
pModel[in] Pointer to the model.
nProp[in] GsModel property type.
Returns
true.

Definition at line 138 of file GsBaseModelReactor.h.


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