selects proxies. More...

#include <vtkSMProxySelectionModel.h>

Inheritance diagram for vtkSMProxySelectionModel:

Collaboration diagram for vtkSMProxySelectionModel:

[legend]

Public Types
enum	ProxySelectionFlag { NO_UPDATE = 0, CLEAR = 1, SELECT = 2, DESELECT = 4, CLEAR_AND_SELECT = CLEAR \| SELECT }

typedef vtkSMRemoteObject	Superclass

typedef std::list< vtkSmartPointer< vtkSMProxy > >	SelectionType
	Type for selection. More...

Public Types inherited from vtkSMRemoteObject
typedef vtkSMSessionObject	Superclass

Public Types inherited from vtkSMSessionObject
typedef vtkSMObject	Superclass

Public Types inherited from vtkSMObject
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetSession (vtkSMSession *) override
	Override the set session, so we can attach an observer to the Collaboration manager in order to monitor master/slave changes. More...

vtkSMProxy *	GetCurrentProxy ()
	Returns the proxy that is current, nullptr if there is no current. More...

void	SetCurrentProxy (vtkSMProxy *proxy, int command)
	Sets the current proxy. More...

bool	IsSelected (vtkSMProxy *proxy)
	Returns true if the proxy is selected. More...

unsigned int	GetNumberOfSelectedProxies ()

vtkSMProxy *	GetSelectedProxy (unsigned int index)
	Returns the selected proxy at the given index. More...

const SelectionType &	GetSelection ()
	Returns the selection set. More...

void	Select (const SelectionType &proxies, int command)
	Update the selected set of proxies. More...

void	Select (vtkSMProxy *proxy, int command)

void	Clear ()
	Wrapper friendly methods to doing what Select() can do. More...

void	Select (vtkSMProxy *proxy)

void	Deselect (vtkSMProxy *proxy)

void	ClearAndSelect (vtkSMProxy *proxy)

bool	GetSelectionDataBounds (double bounds[6])
	Utility method to get the data bounds for the currently selected items. More...

const vtkSMMessage *	GetFullState () override
	This method return the full object state that can be used to create that object from scratch. More...

void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator) override
	This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. More...


void	SetFollowingMaster (bool following)
	Allow to synchronize the active object with master or just keep remote object out-of-synch. More...

bool	IsFollowingMaster ()
	Allow to synchronize the active object with master or just keep remote object out-of-synch. More...

Public Member Functions inherited from vtkSMRemoteObject
void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetSession (vtkSMSession *) override
	Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...

bool	HasGlobalID ()
	Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...

virtual void	EnableLocalPushOnly ()
	Allow to switch off any push of state change to the server for that particular object. More...

virtual void	DisableLocalPushOnly ()
	Enable the given remote object to communicate its state normally to the server location. More...

virtual bool	IsLocalPushOnly ()
	Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...

virtual void	SetLocation (vtkTypeUInt32)
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetLocation ()
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetGlobalID ()
	Get the global unique id for this object. More...

const char *	GetGlobalIDAsString ()
	Get the global unique id for this object. More...

virtual void	PrototypeOn ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	PrototypeOff ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

bool	IsPrototype ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	SetPrototype (bool)
	Allow user to set the remote object to be discard for Undo/Redo action. More...

Public Member Functions inherited from vtkSMSessionObject
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual vtkSMSession *	GetSession ()
	Get/Set the session on wihch this object exists. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkSMProxySelectionModel *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxySelectionModel *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMRemoteObject
static int	IsTypeOf (const char *type)

static vtkSMRemoteObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMObject *	SafeDownCast (vtkObject *o)

static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMProxySelectionModel ()

	~vtkSMProxySelectionModel () override

void	InvokeCurrentChanged (vtkSMProxy *proxy)

void	InvokeSelectionChanged ()

void	PushStateToSession ()
	When the state has changed we call that method so the state can be shared is any collaboration is involved. More...

Protected Member Functions inherited from vtkSMRemoteObject
	vtkSMRemoteObject ()
	Default constructor. More...

	~vtkSMRemoteObject () override
	Destructor. More...

void	PushState (vtkSMMessage *msg)
	Subclasses can call this method to send a message to its state object on the server processes specified. More...

bool	PullState (vtkSMMessage *msg)
	Subclasses can call this method to pull the state from the state-object on the server processes specified. More...

void	SetGlobalID (vtkTypeUInt32 guid)
	Set the GlobalUniqueId. More...

vtkTypeUInt32	GetFilteredLocation ()

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject () override

Protected Member Functions inherited from vtkSMObject
	vtkSMObject ()

	~vtkSMObject () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSmartPointer< vtkSMProxy >	Current

SelectionType	Selection

vtkSMMessage *	State

Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32	GlobalID

vtkTypeUInt32	Location

bool	Prototype

bool	ClientOnlyLocationFlag

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkInternal

Detailed Description

selects proxies.

vtkSMProxySelectionModel is used to select proxies. vtkSMProxyManager uses two instances of vtkSMProxySelectionModel for keeping track of the selected/active sources/filters and the active view.

See also: vtkSMProxyManager

Definition at line 28 of file vtkSMProxySelectionModel.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMRemoteObject vtkSMProxySelectionModel::Superclass

Definition at line 32 of file vtkSMProxySelectionModel.h.

◆ SelectionType

typedef std::list<vtkSmartPointer<vtkSMProxy> > vtkSMProxySelectionModel::SelectionType

Type for selection.

Definition at line 53 of file vtkSMProxySelectionModel.h.

Member Enumeration Documentation

◆ ProxySelectionFlag

enum vtkSMProxySelectionModel::ProxySelectionFlag

Enumerator
NO_UPDATE
CLEAR
SELECT
DESELECT
CLEAR_AND_SELECT

Definition at line 56 of file vtkSMProxySelectionModel.h.

Constructor & Destructor Documentation

◆ vtkSMProxySelectionModel()

vtkSMProxySelectionModel::vtkSMProxySelectionModel ( )

protected

◆ ~vtkSMProxySelectionModel()

vtkSMProxySelectionModel::~vtkSMProxySelectionModel ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMProxySelectionModel* vtkSMProxySelectionModel::New ( )

static

◆ GetClassName()

virtual const char* vtkSMProxySelectionModel::GetClassName ( )

virtual

Reimplemented from vtkSMRemoteObject.

◆ IsTypeOf()

static int vtkSMProxySelectionModel::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSMProxySelectionModel::IsA ( const char * type )

virtual

Reimplemented from vtkSMRemoteObject.

◆ SafeDownCast()

static vtkSMProxySelectionModel* vtkSMProxySelectionModel::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkSMProxySelectionModel::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkSMObject.

◆ SetSession()

void vtkSMProxySelectionModel::SetSession ( vtkSMSession * )

overridevirtual

Override the set session, so we can attach an observer to the Collaboration manager in order to monitor master/slave changes.

Reimplemented from vtkSMSessionObject.

◆ SetFollowingMaster()

void vtkSMProxySelectionModel::SetFollowingMaster ( bool following )

Allow to synchronize the active object with master or just keep remote object out-of-synch.

Only the state from the master will be loaded.

◆ IsFollowingMaster()

bool vtkSMProxySelectionModel::IsFollowingMaster ( )

Allow to synchronize the active object with master or just keep remote object out-of-synch.

Only the state from the master will be loaded.

◆ GetCurrentProxy()

vtkSMProxy* vtkSMProxySelectionModel::GetCurrentProxy ( )

Returns the proxy that is current, nullptr if there is no current.

◆ SetCurrentProxy()

void vtkSMProxySelectionModel::SetCurrentProxy	(	vtkSMProxy *	proxy,
		int	command
	)

Sets the current proxy.

command is used to control how the current selection is affected.

NO_UPDATE: change the current without affecting the selected set of proxies.
CLEAR: clear current selection
SELECT: also select the proxy being set as current
DESELECT: deselect the proxy being set as current.

◆ IsSelected()

bool vtkSMProxySelectionModel::IsSelected ( vtkSMProxy * proxy )

Returns true if the proxy is selected.

◆ GetNumberOfSelectedProxies()

unsigned int vtkSMProxySelectionModel::GetNumberOfSelectedProxies ( )

◆ GetSelectedProxy()

vtkSMProxy* vtkSMProxySelectionModel::GetSelectedProxy ( unsigned int index )

Returns the selected proxy at the given index.

◆ GetSelection()

const SelectionType& vtkSMProxySelectionModel::GetSelection ( )

inline

Returns the selection set.

Definition at line 97 of file vtkSMProxySelectionModel.h.

◆ Select() [1/3]

void vtkSMProxySelectionModel::Select	(	const SelectionType &	proxies,
		int	command
	)

Update the selected set of proxies.

command affects how the selection is updated.

NO_UPDATE: don't affect the selected set of proxies.
CLEAR: clear selection
SELECT: add the proxies to selection
DESELECT: deselect the proxies
CLEAR_AND_SELECT: clear selection and then add the specified proxies as the selection.

◆ Select() [2/3]

void vtkSMProxySelectionModel::Select	(	vtkSMProxy *	proxy,
		int	command
	)

◆ Clear()

void vtkSMProxySelectionModel::Clear ( void )

inline

Wrapper friendly methods to doing what Select() can do.

Definition at line 117 of file vtkSMProxySelectionModel.h.

◆ Select() [3/3]

void vtkSMProxySelectionModel::Select ( vtkSMProxy * proxy )

inline

Definition at line 118 of file vtkSMProxySelectionModel.h.

◆ Deselect()

void vtkSMProxySelectionModel::Deselect ( vtkSMProxy * proxy )

inline

Definition at line 119 of file vtkSMProxySelectionModel.h.

◆ ClearAndSelect()

void vtkSMProxySelectionModel::ClearAndSelect ( vtkSMProxy * proxy )

inline

Definition at line 120 of file vtkSMProxySelectionModel.h.

◆ GetSelectionDataBounds()

bool vtkSMProxySelectionModel::GetSelectionDataBounds ( double bounds[6] )

Utility method to get the data bounds for the currently selected items.

This only makes sense for selections comprising of source-proxies or output-port proxies. Returns true is the bounds are valid.

◆ GetFullState()

const vtkSMMessage* vtkSMProxySelectionModel::GetFullState ( )

overridevirtual

This method return the full object state that can be used to create that object from scratch.

This method will be used to fill the undo stack. If not overridden this will return nullptr.

Reimplemented from vtkSMRemoteObject.

◆ LoadState()

void vtkSMProxySelectionModel::LoadState	(	const vtkSMMessage *	msg,
		vtkSMProxyLocator *	locator
	)

overridevirtual

This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set.

This allow to split the load process in 2 step to prevent invalid state when property refere to a sub-proxy that does not exist yet.

Reimplemented from vtkSMRemoteObject.

◆ InvokeCurrentChanged()

void vtkSMProxySelectionModel::InvokeCurrentChanged ( vtkSMProxy * proxy )

protected

◆ InvokeSelectionChanged()

void vtkSMProxySelectionModel::InvokeSelectionChanged ( )

protected

◆ PushStateToSession()

void vtkSMProxySelectionModel::PushStateToSession ( )

protected

When the state has changed we call that method so the state can be shared is any collaboration is involved.

Friends And Related Function Documentation

◆ vtkInternal

friend class vtkInternal

friend

Definition at line 170 of file vtkSMProxySelectionModel.h.

Member Data Documentation

◆ Current

vtkSmartPointer<vtkSMProxy> vtkSMProxySelectionModel::Current

protected

Definition at line 154 of file vtkSMProxySelectionModel.h.

◆ Selection

SelectionType vtkSMProxySelectionModel::Selection

protected

Definition at line 155 of file vtkSMProxySelectionModel.h.

◆ State

vtkSMMessage* vtkSMProxySelectionModel::State

protected

Definition at line 164 of file vtkSMProxySelectionModel.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMProxySelectionModel.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ SelectionType

Member Enumeration Documentation

◆ ProxySelectionFlag

Constructor & Destructor Documentation

◆ vtkSMProxySelectionModel()

◆ ~vtkSMProxySelectionModel()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetSession()

◆ SetFollowingMaster()

◆ IsFollowingMaster()

◆ GetCurrentProxy()

◆ SetCurrentProxy()

◆ IsSelected()

◆ GetNumberOfSelectedProxies()

◆ GetSelectedProxy()

◆ GetSelection()

◆ Select() [1/3]

◆ Select() [2/3]

◆ Clear()

◆ Select() [3/3]

◆ Deselect()

◆ ClearAndSelect()

◆ GetSelectionDataBounds()

◆ GetFullState()

◆ LoadState()

◆ InvokeCurrentChanged()

◆ InvokeSelectionChanged()

◆ PushStateToSession()

Friends And Related Function Documentation

◆ vtkInternal

Member Data Documentation

◆ Current

◆ Selection

◆ State