VTK
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
vtkViewNode Class Reference

a node within a VTK scene graph More...

#include <vtkViewNode.h>

Inheritance diagram for vtkViewNode:
[legend]
Collaboration diagram for vtkViewNode:
[legend]

Public Types

enum  operation_type {
  noop, build, synchronize, render,
  invalidate
}
 internal mechanics of graph traversal and actions More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkViewNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void Build (bool)
 Builds myself. More...
 
virtual void Synchronize (bool)
 Ensures that my state agrees with my Renderable's. More...
 
virtual void Render (bool)
 Makes calls to make self visible. More...
 
virtual void Invalidate (bool)
 Clear any cached data. More...
 
vtkViewNodeGetViewNodeFor (vtkObject *)
 Returns the view node that corresponding to the provided object Will return NULL if a match is not found in self or descendents. More...
 
vtkViewNodeGetFirstAncestorOfType (const char *type)
 Find the first parent/grandparent of the desired type. More...
 
virtual void SetRenderable (vtkObject *)
 Allow explicit setting of the renderable for a view node. More...
 
virtual void Traverse (int operation)
 
virtual void TraverseAllPasses ()
 
virtual vtkObjectGetRenderable ()
 This is the VTK class that this node stands in for. More...
 
virtual void SetParent (vtkViewNode *)
 Access the node that owns this one. More...
 
virtual vtkViewNodeGetParent ()
 Access the node that owns this one. More...
 
virtual void SetChildren (vtkViewNodeCollection *)
 Access nodes that this one owns. More...
 
virtual vtkViewNodeCollectionGetChildren ()
 Access nodes that this one owns. More...
 
virtual void SetMyFactory (vtkViewNodeFactory *)
 A factory that creates particular subclasses for different rendering back ends. More...
 
virtual vtkViewNodeFactoryGetMyFactory ()
 A factory that creates particular subclasses for different rendering back ends. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkViewNodeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Public Attributes

vtkMTimeType RenderTime
 Allows smart caching. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkViewNode ()
 
 ~vtkViewNode ()
 
void Apply (int operation, bool prepass)
 
void RemoveUnusedNodes ()
 Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes. More...
 
virtual vtkViewNodeCreateViewNode (vtkObject *obj)
 Create the correct ViewNode subclass for the passed in object. More...
 
void AddMissingNode (vtkObject *obj)
 convenience method to add node or nodes if missing from our current list More...
 
void AddMissingNodes (vtkCollection *col)
 convenience method to add node or nodes if missing from our current list More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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

vtkObjectRenderable
 
vtkWeakPointer< vtkViewNodeParent
 
vtkViewNodeCollectionChildren
 
vtkViewNodeFactoryMyFactory
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static const char * operation_type_strings []
 

Friends

class vtkViewNodeFactory
 
vtkCollectionPreparedNodes
 Called first before adding missing nodes. More...
 
void PrepareNodes ()
 Called first before adding missing nodes. More...
 

Detailed Description

a node within a VTK scene graph

This is the superclass for all nodes within a VTK scene graph. It contains the API for a node. It supports the essential operations such as graph creation, state storage and traversal. Child classes adapt this to VTK's major rendering classes. Grandchild classes adapt those to for APIs of different rendering libraries.

Tests:
vtkViewNode (Tests)

Definition at line 40 of file vtkViewNode.h.

Member Typedef Documentation

Definition at line 44 of file vtkViewNode.h.

Member Enumeration Documentation

internal mechanics of graph traversal and actions

Enumerator
noop 
build 
synchronize 
render 
invalidate 

Definition at line 130 of file vtkViewNode.h.

Constructor & Destructor Documentation

vtkViewNode::vtkViewNode ( )
protected
vtkViewNode::~vtkViewNode ( )
protected

Member Function Documentation

static vtkTypeBool vtkViewNode::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkViewNode::IsA ( const char *  name)
virtual
static vtkViewNode* vtkViewNode::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkViewNode::NewInstanceInternal ( ) const
protectedvirtual
vtkViewNode* vtkViewNode::NewInstance ( ) const
void vtkViewNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkVolumeMapperNode, vtkWindowNode, and vtkVolumeNode.

virtual vtkObject* vtkViewNode::GetRenderable ( )
virtual

This is the VTK class that this node stands in for.

virtual void vtkViewNode::Build ( bool  )
inlinevirtual

Builds myself.

Reimplemented in vtkOptiXRendererNode, vtkOSPRayRendererNode, vtkWindowNode, vtkActorNode, vtkRendererNode, and vtkVolumeNode.

Definition at line 57 of file vtkViewNode.h.

virtual void vtkViewNode::Synchronize ( bool  )
inlinevirtual

Ensures that my state agrees with my Renderable's.

Reimplemented in vtkOptiXRendererNode, vtkWindowNode, and vtkRendererNode.

Definition at line 62 of file vtkViewNode.h.

virtual void vtkViewNode::Render ( bool  )
inlinevirtual
virtual void vtkViewNode::Invalidate ( bool  )
inlinevirtual

Clear any cached data.

Reimplemented in vtkOSPRayRendererNode, vtkOSPRayCompositePolyDataMapper2Node, and vtkOSPRayPolyDataMapperNode.

Definition at line 72 of file vtkViewNode.h.

virtual void vtkViewNode::SetParent ( vtkViewNode )
virtual

Access the node that owns this one.

virtual vtkViewNode* vtkViewNode::GetParent ( )
virtual

Access the node that owns this one.

virtual void vtkViewNode::SetChildren ( vtkViewNodeCollection )
virtual

Access nodes that this one owns.

virtual vtkViewNodeCollection* vtkViewNode::GetChildren ( )
virtual

Access nodes that this one owns.

virtual void vtkViewNode::SetMyFactory ( vtkViewNodeFactory )
virtual

A factory that creates particular subclasses for different rendering back ends.

virtual vtkViewNodeFactory* vtkViewNode::GetMyFactory ( )
virtual

A factory that creates particular subclasses for different rendering back ends.

vtkViewNode* vtkViewNode::GetViewNodeFor ( vtkObject )

Returns the view node that corresponding to the provided object Will return NULL if a match is not found in self or descendents.

vtkViewNode* vtkViewNode::GetFirstAncestorOfType ( const char *  type)

Find the first parent/grandparent of the desired type.

virtual void vtkViewNode::SetRenderable ( vtkObject )
virtual

Allow explicit setting of the renderable for a view node.

virtual void vtkViewNode::Traverse ( int  operation)
virtual
virtual void vtkViewNode::TraverseAllPasses ( )
virtual
void vtkViewNode::Apply ( int  operation,
bool  prepass 
)
protected
void vtkViewNode::AddMissingNode ( vtkObject obj)
protected

convenience method to add node or nodes if missing from our current list

void vtkViewNode::AddMissingNodes ( vtkCollection col)
protected

convenience method to add node or nodes if missing from our current list

void vtkViewNode::PrepareNodes ( )
protected

Called first before adding missing nodes.

Keeps track of the nodes that should be in the collection

void vtkViewNode::RemoveUnusedNodes ( )
protected

Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes.

virtual vtkViewNode* vtkViewNode::CreateViewNode ( vtkObject obj)
protectedvirtual

Create the correct ViewNode subclass for the passed in object.

Friends And Related Function Documentation

friend class vtkViewNodeFactory
friend

Definition at line 174 of file vtkViewNode.h.

Member Data Documentation

vtkMTimeType vtkViewNode::RenderTime

Allows smart caching.

Definition at line 125 of file vtkViewNode.h.

const char* vtkViewNode::operation_type_strings[]
staticprotected

Definition at line 136 of file vtkViewNode.h.

vtkCollection* vtkViewNode::PreparedNodes
protected

Called first before adding missing nodes.

Keeps track of the nodes that should be in the collection

Definition at line 155 of file vtkViewNode.h.

vtkObject* vtkViewNode::Renderable
protected

Definition at line 169 of file vtkViewNode.h.

vtkWeakPointer<vtkViewNode> vtkViewNode::Parent
protected

Definition at line 170 of file vtkViewNode.h.

vtkViewNodeCollection* vtkViewNode::Children
protected

Definition at line 171 of file vtkViewNode.h.

vtkViewNodeFactory* vtkViewNode::MyFactory
protected

Definition at line 172 of file vtkViewNode.h.


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