ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkSMCameraLink Class Reference

creates a link between two cameras. More...

#include <vtkSMCameraLink.h>

Inheritance diagram for vtkSMCameraLink:
Inheritance graph
[legend]
Collaboration diagram for vtkSMCameraLink:
Collaboration graph
[legend]

Public Types

typedef vtkSMProxyLink Superclass
 
- 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)
 
void AddLinkedProxy (vtkSMProxy *proxy, int updateDir)
 Add a property to the link. More...
 
virtual void RemoveLinkedProxy (vtkSMProxy *proxy)
 Remove a linked proxy. More...
 
virtual void UpdateViews (vtkSMProxy *caller, bool interactive)
 Update all the views linked with an OUTPUT direction. More...
 
virtual void LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator)
 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...
 
virtual void SetSynchronizeInteractiveRenders (int)
 Get/Set if the link should synchronize interactive renders as well. More...
 
virtual int GetSynchronizeInteractiveRenders ()
 Get/Set if the link should synchronize interactive renders as well. More...
 
virtual void SynchronizeInteractiveRendersOn ()
 Get/Set if the link should synchronize interactive renders as well. More...
 
virtual void SynchronizeInteractiveRendersOff ()
 Get/Set if the link should synchronize interactive renders as well. More...
 
- Public Member Functions inherited from vtkSMRemoteObject
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetSession (vtkSMSession *)
 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 normaly 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)
 
virtual vtkSMSessionProxyManagerGetSessionProxyManager ()
 Return the corresponding ProxyManager if any. More...
 
virtual vtkSMSessionGetSession ()
 Get/Set the session on wihch this object exists. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static vtkSMCameraLinkNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMCameraLinkSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMRemoteObject
static int IsTypeOf (const char *type)
 
static vtkSMRemoteObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSMCameraLink ()
 
 ~vtkSMCameraLink ()
 
virtual void UpdateVTKObjects (vtkSMProxy *proxy)
 Called when an input proxy is updated (UpdateVTKObjects). More...
 
virtual void PropertyModified (vtkSMProxy *proxy, const char *pname)
 Called when a property of an input proxy is modified. More...
 
virtual void UpdateProperty (vtkSMProxy *, const char *)
 Called when a property is pushed. More...
 
virtual void SaveXMLState (const char *linkname, vtkPVXMLElement *parent)
 Save the state of the link. More...
 
void CopyProperties (vtkSMProxy *caller)
 Internal method to copy vtkSMproperty values from caller to all linked proxies. More...
 
void StartInteraction (vtkObject *caller)
 
void EndInteraction (vtkObject *caller)
 
void ResetCamera (vtkObject *caller)
 
virtual void UpdateState ()
 Update the internal protobuf state. More...
 
- Protected Member Functions inherited from vtkSMRemoteObject
 vtkSMRemoteObject ()
 Default constructor. More...
 
virtual ~vtkSMRemoteObject ()
 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 ()
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject ()
 

Protected Attributes

int SynchronizeInteractiveRenders
 
- Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32 GlobalID
 
vtkTypeUInt32 Location
 
bool Prototype
 
bool ClientOnlyLocationFlag
 
- Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSessionSession
 

Friends

class vtkInternals
 

Detailed Description

creates a link between two cameras.

When a link is created between camera A->B, whenever any property on camera A is modified, a property with the same name as the modified property (if any) on camera B is also modified to be the same as the property on the camera A. Similary whenever camera A->UpdateVTKObjects() is called, B->UpdateVTKObjects() is also fired.

Definition at line 32 of file vtkSMCameraLink.h.

Member Typedef Documentation

§ Superclass

Definition at line 36 of file vtkSMCameraLink.h.

Constructor & Destructor Documentation

§ vtkSMCameraLink()

vtkSMCameraLink::vtkSMCameraLink ( )
protected

§ ~vtkSMCameraLink()

vtkSMCameraLink::~vtkSMCameraLink ( )
protected

Member Function Documentation

§ New()

static vtkSMCameraLink* vtkSMCameraLink::New ( )
static

§ GetClassName()

virtual const char* vtkSMCameraLink::GetClassName ( )
virtual

Reimplemented from vtkSMProxyLink.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkSMProxyLink.

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetSynchronizeInteractiveRenders()

virtual void vtkSMCameraLink::SetSynchronizeInteractiveRenders ( int  )
virtual

Get/Set if the link should synchronize interactive renders as well.

On by default.

§ GetSynchronizeInteractiveRenders()

virtual int vtkSMCameraLink::GetSynchronizeInteractiveRenders ( )
virtual

Get/Set if the link should synchronize interactive renders as well.

On by default.

§ SynchronizeInteractiveRendersOn()

virtual void vtkSMCameraLink::SynchronizeInteractiveRendersOn ( )
virtual

Get/Set if the link should synchronize interactive renders as well.

On by default.

§ SynchronizeInteractiveRendersOff()

virtual void vtkSMCameraLink::SynchronizeInteractiveRendersOff ( )
virtual

Get/Set if the link should synchronize interactive renders as well.

On by default.

§ AddLinkedProxy()

void vtkSMCameraLink::AddLinkedProxy ( vtkSMProxy proxy,
int  updateDir 
)
virtual

Add a property to the link.

updateDir determines whether a property of the proxy is read or written. When a property of an input proxy changes, it's value is pushed to all other output proxies in the link. A proxy can be set to be both input and output by setting updateDir to INPUT | OUTPUT

Reimplemented from vtkSMProxyLink.

§ RemoveLinkedProxy()

virtual void vtkSMCameraLink::RemoveLinkedProxy ( vtkSMProxy proxy)
virtual

Remove a linked proxy.

Reimplemented from vtkSMProxyLink.

§ UpdateViews()

virtual void vtkSMCameraLink::UpdateViews ( vtkSMProxy caller,
bool  interactive 
)
virtual

Update all the views linked with an OUTPUT direction.

interactive indicates if the render is interactive or not.

§ LoadState()

virtual void vtkSMCameraLink::LoadState ( const vtkSMMessage msg,
vtkSMProxyLocator locator 
)
virtual

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 vtkSMProxyLink.

§ UpdateVTKObjects()

virtual void vtkSMCameraLink::UpdateVTKObjects ( vtkSMProxy proxy)
protectedvirtual

Called when an input proxy is updated (UpdateVTKObjects).

Argument is the input proxy.

Reimplemented from vtkSMProxyLink.

§ PropertyModified()

virtual void vtkSMCameraLink::PropertyModified ( vtkSMProxy proxy,
const char *  pname 
)
protectedvirtual

Called when a property of an input proxy is modified.

caller:- the input proxy. pname:- name of the property being modified.

Reimplemented from vtkSMProxyLink.

§ UpdateProperty()

virtual void vtkSMCameraLink::UpdateProperty ( vtkSMProxy ,
const char *   
)
inlineprotectedvirtual

Called when a property is pushed.

caller :- the input proxy. pname :- name of property that was pushed.

Reimplemented from vtkSMProxyLink.

Definition at line 100 of file vtkSMCameraLink.h.

§ SaveXMLState()

virtual void vtkSMCameraLink::SaveXMLState ( const char *  linkname,
vtkPVXMLElement parent 
)
protectedvirtual

Save the state of the link.

Reimplemented from vtkSMProxyLink.

§ CopyProperties()

void vtkSMCameraLink::CopyProperties ( vtkSMProxy caller)
protected

Internal method to copy vtkSMproperty values from caller to all linked proxies.

§ StartInteraction()

void vtkSMCameraLink::StartInteraction ( vtkObject *  caller)
protected

§ EndInteraction()

void vtkSMCameraLink::EndInteraction ( vtkObject *  caller)
protected

§ ResetCamera()

void vtkSMCameraLink::ResetCamera ( vtkObject *  caller)
protected

§ UpdateState()

virtual void vtkSMCameraLink::UpdateState ( )
protectedvirtual

Update the internal protobuf state.

Reimplemented from vtkSMProxyLink.

Friends And Related Function Documentation

§ vtkInternals

friend class vtkInternals
friend

Definition at line 127 of file vtkSMCameraLink.h.

Member Data Documentation

§ SynchronizeInteractiveRenders

int vtkSMCameraLink::SynchronizeInteractiveRenders
protected

Definition at line 117 of file vtkSMCameraLink.h.


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