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 vtkObjectGetRenderable ()
 This is the VTK class that this node stands in for. 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...
 
virtual void SetParent (vtkViewNode *)
 Access the node that owns this one. More...
 
virtual vtkViewNodeGetParent ()
 
virtual void SetChildren (vtkViewNodeCollection *)
 Access nodes that this one owns. More...
 
virtual vtkViewNodeCollectionGetChildren ()
 
virtual void SetMyFactory (vtkViewNodeFactory *)
 A factory that creates particular subclasses for different rendering back ends. More...
 
virtual vtkViewNodeFactoryGetMyFactory ()
 
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 ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 AddMissingNode (vtkObject *obj)
 convenience method to add node or nodes if missing from our current list More...
 
void AddMissingNodes (vtkCollection *col)
 
void PrepareNodes ()
 Called first before adding missing nodes. More...
 
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...
 
- 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 ()
 
- 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

vtkCollectionPreparedNodes
 
vtkObjectRenderable
 
vtkWeakPointer< vtkViewNodeParent
 
vtkViewNodeCollectionChildren
 
vtkViewNodeFactoryMyFactory
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static const char * operation_type_strings []
 

Friends

class vtkViewNodeFactory
 

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

◆ Superclass

Definition at line 44 of file vtkViewNode.h.

Member Enumeration Documentation

◆ operation_type

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::vtkViewNode ( )
protected

◆ ~vtkViewNode()

vtkViewNode::~vtkViewNode ( )
protected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkViewNode::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkViewNode::IsA ( const char *  name)
virtual

◆ SafeDownCast()

static vtkViewNode* vtkViewNode::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkViewNode::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkViewNode* vtkViewNode::NewInstance ( ) const

◆ PrintSelf()

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.

◆ GetRenderable()

virtual vtkObject* vtkViewNode::GetRenderable ( )
virtual

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

◆ Build()

virtual void vtkViewNode::Build ( bool  )
inlinevirtual

Builds myself.

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

Definition at line 57 of file vtkViewNode.h.

◆ Synchronize()

virtual void vtkViewNode::Synchronize ( bool  )
inlinevirtual

Ensures that my state agrees with my Renderable's.

Reimplemented in vtkWindowNode, and vtkRendererNode.

Definition at line 62 of file vtkViewNode.h.

◆ Render()

virtual void vtkViewNode::Render ( bool  )
inlinevirtual

◆ Invalidate()

virtual void vtkViewNode::Invalidate ( bool  )
inlinevirtual

Clear any cached data.

Reimplemented in vtkOSPRayRendererNode, vtkOSPRayCompositePolyDataMapper2Node, and vtkOSPRayPolyDataMapperNode.

Definition at line 72 of file vtkViewNode.h.

◆ SetParent()

virtual void vtkViewNode::SetParent ( vtkViewNode )
virtual

Access the node that owns this one.

◆ GetParent()

virtual vtkViewNode* vtkViewNode::GetParent ( )
virtual

◆ SetChildren()

virtual void vtkViewNode::SetChildren ( vtkViewNodeCollection )
virtual

Access nodes that this one owns.

◆ GetChildren()

virtual vtkViewNodeCollection* vtkViewNode::GetChildren ( )
virtual

◆ SetMyFactory()

virtual void vtkViewNode::SetMyFactory ( vtkViewNodeFactory )
virtual

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

◆ GetMyFactory()

virtual vtkViewNodeFactory* vtkViewNode::GetMyFactory ( )
virtual

◆ GetViewNodeFor()

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.

◆ GetFirstAncestorOfType()

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

Find the first parent/grandparent of the desired type.

◆ SetRenderable()

virtual void vtkViewNode::SetRenderable ( vtkObject )
virtual

Allow explicit setting of the renderable for a view node.

◆ Traverse()

virtual void vtkViewNode::Traverse ( int  operation)
virtual

Reimplemented in vtkOSPRayRendererNode.

◆ TraverseAllPasses()

virtual void vtkViewNode::TraverseAllPasses ( )
virtual

◆ Apply()

void vtkViewNode::Apply ( int  operation,
bool  prepass 
)
protected

◆ AddMissingNode()

void vtkViewNode::AddMissingNode ( vtkObject obj)
protected

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

◆ AddMissingNodes()

void vtkViewNode::AddMissingNodes ( vtkCollection col)
protected

◆ PrepareNodes()

void vtkViewNode::PrepareNodes ( )
protected

Called first before adding missing nodes.

Keeps track of the nodes that should be in the collection

◆ RemoveUnusedNodes()

void vtkViewNode::RemoveUnusedNodes ( )
protected

Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes.

◆ CreateViewNode()

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

Create the correct ViewNode subclass for the passed in object.

Friends And Related Function Documentation

◆ vtkViewNodeFactory

friend class vtkViewNodeFactory
friend

Definition at line 174 of file vtkViewNode.h.

Member Data Documentation

◆ RenderTime

vtkMTimeType vtkViewNode::RenderTime

Allows smart caching.

Definition at line 125 of file vtkViewNode.h.

◆ operation_type_strings

const char* vtkViewNode::operation_type_strings[]
staticprotected

Definition at line 136 of file vtkViewNode.h.

◆ PreparedNodes

vtkCollection* vtkViewNode::PreparedNodes
protected

Definition at line 155 of file vtkViewNode.h.

◆ Renderable

vtkObject* vtkViewNode::Renderable
protected

Definition at line 169 of file vtkViewNode.h.

◆ Parent

vtkWeakPointer<vtkViewNode> vtkViewNode::Parent
protected

Definition at line 170 of file vtkViewNode.h.

◆ Children

vtkViewNodeCollection* vtkViewNode::Children
protected

Definition at line 171 of file vtkViewNode.h.

◆ MyFactory

vtkViewNodeFactory* vtkViewNode::MyFactory
protected

Definition at line 172 of file vtkViewNode.h.


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