Class used to retreive a given message state based on its GlobalID.
More...
#include <vtkSMStateLocator.h>
|
virtual const char * | GetClassName () |
|
virtual int | IsA (const char *type) |
|
void | PrintSelf (ostream &os, vtkIndent indent) |
|
void | InitGarbageCollector (vtkSMSession *, vtkUndoStack *) |
| By initializing the garabage collector the stored state get removed once their is no more chance for them to be reused inside the session. More...
|
|
virtual bool | FindState (vtkTypeUInt32 globalID, vtkSMMessage *stateToFill, bool useParent=true) |
| Fill the provided State message with the state found inside the current locator or one of its parent. More...
|
|
virtual void | RegisterState (const vtkSMMessage *state) |
| Register the given state in the current locator. More...
|
|
virtual void | UnRegisterState (vtkTypeUInt32 globalID, bool force) |
| Remove a state for a given proxy inside the local locator. More...
|
|
virtual void | UnRegisterAllStates (bool force) |
| Remove all the registered states if force is true, it will also remove it from its hierarchical parents. More...
|
|
virtual bool | IsStateLocal (vtkTypeUInt32 globalID) |
| Return true if the given state can be found locally whitout the help of on the hierarchical parent. More...
|
|
virtual bool | IsStateAvailable (vtkTypeUInt32 globalID) |
| Return true if the given state do exist in the locator hierachy. More...
|
|
virtual void | RegisterFullState (vtkSMProxy *proxy) |
| Register the given proxy state as well as all its sub-proxy state so if that proxy need to be renew all its sub-proxy will be renew in the exact same state. More...
|
|
|
virtual void | SetParentLocator (vtkSMStateLocator *) |
| Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally. More...
|
|
virtual vtkSMStateLocator * | GetParentLocator () |
| Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally. More...
|
|
void | PrintSelf (ostream &os, vtkIndent indent) |
|
Class used to retreive a given message state based on its GlobalID.
vtkSMStateLocator allow a hierarchical way of finding a message state.
Definition at line 35 of file vtkSMStateLocator.h.
◆ Superclass
◆ vtkSMStateLocator()
vtkSMStateLocator::vtkSMStateLocator |
( |
| ) |
|
|
protected |
◆ ~vtkSMStateLocator()
vtkSMStateLocator::~vtkSMStateLocator |
( |
| ) |
|
|
protected |
◆ New()
◆ GetClassName()
virtual const char* vtkSMStateLocator::GetClassName |
( |
| ) |
|
|
virtual |
◆ IsTypeOf()
static int vtkSMStateLocator::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
◆ IsA()
virtual int vtkSMStateLocator::IsA |
( |
const char * |
type | ) |
|
|
virtual |
◆ SafeDownCast()
◆ PrintSelf()
void vtkSMStateLocator::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
◆ SetParentLocator()
Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally.
◆ GetParentLocator()
Set/Get a parent locator to search which is used as a backup location to search from if a given state was not found locally.
◆ InitGarbageCollector()
By initializing the garabage collector the stored state get removed once their is no more chance for them to be reused inside the session.
◆ FindState()
virtual bool vtkSMStateLocator::FindState |
( |
vtkTypeUInt32 |
globalID, |
|
|
vtkSMMessage * |
stateToFill, |
|
|
bool |
useParent = true |
|
) |
| |
|
virtual |
Fill the provided State message with the state found inside the current locator or one of its parent.
The method return true if the state was successfully filled. The "useParent" flag allow to disable parent lookup but by default it is set to true.
Reimplemented in vtkSMServerStateLocator.
◆ RegisterState()
virtual void vtkSMStateLocator::RegisterState |
( |
const vtkSMMessage * |
state | ) |
|
|
virtual |
Register the given state in the current locator.
If a previous state was available, the new one will replace it.
◆ UnRegisterState()
virtual void vtkSMStateLocator::UnRegisterState |
( |
vtkTypeUInt32 |
globalID, |
|
|
bool |
force |
|
) |
| |
|
virtual |
Remove a state for a given proxy inside the local locator.
if force is true, it will also remove it from its hierarchical parents.
◆ UnRegisterAllStates()
virtual void vtkSMStateLocator::UnRegisterAllStates |
( |
bool |
force | ) |
|
|
virtual |
Remove all the registered states if force is true, it will also remove it from its hierarchical parents.
◆ IsStateLocal()
virtual bool vtkSMStateLocator::IsStateLocal |
( |
vtkTypeUInt32 |
globalID | ) |
|
|
virtual |
Return true if the given state can be found locally whitout the help of on the hierarchical parent.
◆ IsStateAvailable()
virtual bool vtkSMStateLocator::IsStateAvailable |
( |
vtkTypeUInt32 |
globalID | ) |
|
|
virtual |
Return true if the given state do exist in the locator hierachy.
◆ RegisterFullState()
virtual void vtkSMStateLocator::RegisterFullState |
( |
vtkSMProxy * |
proxy | ) |
|
|
virtual |
Register the given proxy state as well as all its sub-proxy state so if that proxy need to be renew all its sub-proxy will be renew in the exact same state.
◆ ParentLocator
◆ Session
◆ UndoStack
The documentation for this class was generated from the following file: