VTK
|
a node within a VTK scene graph More...
#include <vtkViewNode.h>
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... | |
vtkViewNode * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual vtkObject * | GetRenderable () |
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 vtkViewNode * | GetParent () |
virtual void | SetChildren (vtkViewNodeCollection *) |
Access nodes that this one owns. More... | |
virtual vtkViewNodeCollection * | GetChildren () |
virtual void | SetMyFactory (vtkViewNodeFactory *) |
A factory that creates particular subclasses for different rendering back ends. More... | |
virtual vtkViewNodeFactory * | GetMyFactory () |
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. More... | |
vtkViewNode * | GetFirstAncestorOfType (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 () |
![]() | |
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) |
vtkCommand * | GetCommand (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) |
![]() | |
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 vtkViewNode * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
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 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 vtkObjectBase * | New () |
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 vtkObjectBase * | NewInstanceInternal () 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 vtkViewNode * | CreateViewNode (vtkObject *obj) |
Create the correct ViewNode subclass for the passed in object. More... | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkCollection * | PreparedNodes |
vtkObject * | Renderable |
vtkWeakPointer< vtkViewNode > | Parent |
vtkViewNodeCollection * | Children |
vtkViewNodeFactory * | MyFactory |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Static Protected Attributes | |
static const char * | operation_type_strings [] |
Friends | |
class | vtkViewNodeFactory |
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.
Definition at line 40 of file vtkViewNode.h.
typedef vtkObject vtkViewNode::Superclass |
Definition at line 44 of file vtkViewNode.h.
internal mechanics of graph traversal and actions
Enumerator | |
---|---|
noop | |
build | |
synchronize | |
render | |
invalidate |
Definition at line 130 of file vtkViewNode.h.
|
protected |
|
protected |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObjectBase.
Reimplemented in vtkOptiXRendererNode, vtkOSPRayActorNode, vtkOSPRayRendererNode, vtkOptiXActorNode, vtkOSPRayLightNode, vtkOSPRayVolumeNode, vtkPolyDataMapperNode, vtkVolumeMapperNode, vtkOptiXPolyDataMapperNode, vtkOSPRayVolumeMapperNode, vtkMapperNode, vtkOptiXCompositePolyDataMapper2Node, vtkOSPRayCompositePolyDataMapper2Node, vtkOSPRayTetrahedraMapperNode, vtkWindowNode, vtkActorNode, vtkRendererNode, vtkOptiXLightNode, vtkOptiXWindowNode, vtkOSPRayAMRVolumeMapperNode, vtkOSPRayPolyDataMapperNode, vtkOSPRayWindowNode, vtkCameraNode, vtkLightNode, vtkVolumeNode, vtkOptiXCameraNode, and vtkOSPRayCameraNode.
|
static |
|
protectedvirtual |
Reimplemented in vtkOptiXRendererNode, vtkOSPRayActorNode, vtkOSPRayRendererNode, vtkOptiXActorNode, vtkOSPRayLightNode, vtkOSPRayVolumeNode, vtkPolyDataMapperNode, vtkVolumeMapperNode, vtkOptiXPolyDataMapperNode, vtkOSPRayVolumeMapperNode, vtkMapperNode, vtkOptiXCompositePolyDataMapper2Node, vtkOSPRayCompositePolyDataMapper2Node, vtkOSPRayTetrahedraMapperNode, vtkWindowNode, vtkActorNode, vtkRendererNode, vtkOptiXLightNode, vtkOptiXWindowNode, vtkOSPRayAMRVolumeMapperNode, vtkOSPRayPolyDataMapperNode, vtkOSPRayWindowNode, vtkCameraNode, vtkLightNode, vtkVolumeNode, vtkOptiXCameraNode, and vtkOSPRayCameraNode.
vtkViewNode* vtkViewNode::NewInstance | ( | ) | const |
|
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 |
This is the VTK class that this node stands in for.
|
inlinevirtual |
Builds myself.
Reimplemented in vtkOSPRayRendererNode, vtkWindowNode, vtkActorNode, vtkRendererNode, vtkVolumeNode, and vtkOptiXRendererNode.
Definition at line 57 of file vtkViewNode.h.
|
inlinevirtual |
Ensures that my state agrees with my Renderable's.
Reimplemented in vtkWindowNode, vtkRendererNode, and vtkOptiXRendererNode.
Definition at line 62 of file vtkViewNode.h.
|
inlinevirtual |
Makes calls to make self visible.
Reimplemented in vtkOSPRayRendererNode, vtkOSPRayLightNode, vtkOSPRayTetrahedraMapperNode, vtkOSPRayVolumeMapperNode, vtkOptiXCompositePolyDataMapper2Node, vtkOSPRayCompositePolyDataMapper2Node, vtkOSPRayAMRVolumeMapperNode, vtkOSPRayPolyDataMapperNode, vtkOSPRayWindowNode, vtkOSPRayCameraNode, vtkOptiXRendererNode, vtkOptiXPolyDataMapperNode, vtkOptiXLightNode, vtkOptiXWindowNode, and vtkOptiXCameraNode.
Definition at line 67 of file vtkViewNode.h.
|
inlinevirtual |
Clear any cached data.
Reimplemented in vtkOSPRayRendererNode, vtkOSPRayCompositePolyDataMapper2Node, and vtkOSPRayPolyDataMapperNode.
Definition at line 72 of file vtkViewNode.h.
|
virtual |
Access the node that owns this one.
|
virtual |
|
virtual |
Access nodes that this one owns.
|
virtual |
|
virtual |
A factory that creates particular subclasses for different rendering back ends.
|
virtual |
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 |
Allow explicit setting of the renderable for a view node.
|
virtual |
Reimplemented in vtkOSPRayRendererNode, and vtkOptiXRendererNode.
|
virtual |
|
protected |
|
protected |
convenience method to add node or nodes if missing from our current list
|
protected |
|
protected |
Called first before adding missing nodes.
Keeps track of the nodes that should be in the collection
|
protected |
Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes.
|
protectedvirtual |
Create the correct ViewNode subclass for the passed in object.
|
friend |
Definition at line 174 of file vtkViewNode.h.
vtkMTimeType vtkViewNode::RenderTime |
Allows smart caching.
Definition at line 125 of file vtkViewNode.h.
|
staticprotected |
Definition at line 136 of file vtkViewNode.h.
|
protected |
Definition at line 155 of file vtkViewNode.h.
|
protected |
Definition at line 169 of file vtkViewNode.h.
|
protected |
Definition at line 170 of file vtkViewNode.h.
|
protected |
Definition at line 171 of file vtkViewNode.h.
|
protected |
Definition at line 172 of file vtkViewNode.h.