VTK
9.1.0
|
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. | |
vtkViewNode * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | Build (bool) |
Builds myself. | |
virtual void | Synchronize (bool) |
Ensures that my state agrees with my Renderable's. | |
virtual void | Render (bool) |
Makes calls to make self visible. | |
virtual void | Invalidate (bool) |
Clear any cached data. | |
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 * | GetFirstAncestorOfType (const char *type) |
Find the first parent/grandparent of the desired type. | |
vtkViewNode * | GetFirstChildOfType (const char *type) |
Find the first child of the desired type. | |
virtual void | SetRenderable (vtkObject *) |
Allow explicit setting of the renderable for a view node. | |
virtual void | Traverse (int operation) |
virtual void | TraverseAllPasses () |
virtual vtkObject * | GetRenderable () |
This is the VTK class that this node stands in for. | |
virtual void | SetParent (vtkViewNode *) |
Access the node that owns this one. | |
virtual vtkViewNode * | GetParent () |
Access the node that owns this one. | |
virtual std::list< vtkViewNode * > const & | GetChildren () |
Access nodes that this one owns. | |
virtual void | SetMyFactory (vtkViewNodeFactory *) |
A factory that creates particular subclasses for different rendering back ends. | |
virtual vtkViewNodeFactory * | GetMyFactory () |
A factory that creates particular subclasses for different rendering back ends. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkViewNode * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Public Attributes | |
vtkMTimeType | RenderTime |
Allows smart caching. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkViewNode () | |
~vtkViewNode () override | |
virtual void | Apply (int operation, bool prepass) |
void | RemoveUnusedNodes () |
Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes. | |
virtual vtkViewNode * | CreateViewNode (vtkObject *obj) |
Create the correct ViewNode subclass for the passed in object. | |
void | AddMissingNode (vtkObject *obj) |
convenience method to add node or nodes if missing from our current list | |
void | AddMissingNodes (vtkCollection *col) |
convenience method to add node or nodes if missing from our current list | |
void | PrepareNodes () |
Called first before adding missing nodes. | |
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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkObject * | Renderable |
vtkWeakPointer< vtkViewNode > | Parent |
std::list< vtkViewNode * > | Children |
vtkViewNodeFactory * | MyFactory |
std::map< vtkObject *, vtkViewNode * > | Renderables |
bool | Used |
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 |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 38 of file vtkViewNode.h.
typedef vtkObject vtkViewNode::Superclass |
Definition at line 41 of file vtkViewNode.h.
internal mechanics of graph traversal and actions
Enumerator | |
---|---|
noop | |
build | |
synchronize | |
render | |
invalidate |
Definition at line 131 of file vtkViewNode.h.
|
protected |
|
overrideprotected |
|
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 vtkOSPRayActorNode, vtkOSPRayAMRVolumeMapperNode, vtkOSPRayCameraNode, vtkOSPRayCompositePolyDataMapper2Node, vtkOSPRayLightNode, vtkOSPRayMoleculeMapperNode, vtkOSPRayPolyDataMapperNode, vtkOSPRayRendererNode, vtkOSPRayUnstructuredVolumeMapperNode, vtkOSPRayVolumeMapperNode, vtkOSPRayVolumeNode, vtkOSPRayWindowNode, vtkActorNode, vtkCameraNode, vtkLightNode, vtkMapperNode, vtkPolyDataMapperNode, vtkRendererNode, vtkVolumeMapperNode, vtkVolumeNode, and vtkWindowNode.
|
static |
|
protectedvirtual |
Reimplemented in vtkOSPRayActorNode, vtkOSPRayAMRVolumeMapperNode, vtkOSPRayCameraNode, vtkOSPRayCompositePolyDataMapper2Node, vtkOSPRayLightNode, vtkOSPRayMoleculeMapperNode, vtkOSPRayPolyDataMapperNode, vtkOSPRayRendererNode, vtkOSPRayUnstructuredVolumeMapperNode, vtkOSPRayVolumeMapperNode, vtkOSPRayVolumeNode, vtkOSPRayWindowNode, vtkActorNode, vtkCameraNode, vtkLightNode, vtkMapperNode, vtkPolyDataMapperNode, vtkRendererNode, vtkVolumeMapperNode, vtkVolumeNode, and vtkWindowNode.
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, vtkVolumeNode, and vtkWindowNode.
|
virtual |
This is the VTK class that this node stands in for.
|
inlinevirtual |
Builds myself.
Reimplemented in vtkOSPRayRendererNode, vtkActorNode, vtkRendererNode, vtkVolumeNode, and vtkWindowNode.
Definition at line 54 of file vtkViewNode.h.
|
inlinevirtual |
Ensures that my state agrees with my Renderable's.
Reimplemented in vtkWindowNode.
Definition at line 59 of file vtkViewNode.h.
|
inlinevirtual |
Makes calls to make self visible.
Reimplemented in vtkOSPRayAMRVolumeMapperNode, vtkOSPRayCameraNode, vtkOSPRayCompositePolyDataMapper2Node, vtkOSPRayLightNode, vtkOSPRayMoleculeMapperNode, vtkOSPRayPolyDataMapperNode, vtkOSPRayRendererNode, vtkOSPRayUnstructuredVolumeMapperNode, vtkOSPRayVolumeMapperNode, and vtkOSPRayWindowNode.
Definition at line 64 of file vtkViewNode.h.
|
inlinevirtual |
Clear any cached data.
Reimplemented in vtkOSPRayCompositePolyDataMapper2Node, vtkOSPRayPolyDataMapperNode, and vtkOSPRayRendererNode.
Definition at line 69 of file vtkViewNode.h.
|
virtual |
Access the node that owns this one.
|
virtual |
Access the node that owns this one.
|
inlinevirtual |
Access nodes that this one owns.
Definition at line 83 of file vtkViewNode.h.
|
virtual |
A factory that creates particular subclasses for different rendering back ends.
|
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.
vtkViewNode * vtkViewNode::GetFirstChildOfType | ( | const char * | type | ) |
Find the first child of the desired type.
|
virtual |
Allow explicit setting of the renderable for a view node.
|
virtual |
Reimplemented in vtkOSPRayRendererNode.
|
virtual |
|
protectedvirtual |
|
protected |
convenience method to add node or nodes if missing from our current list
|
protected |
convenience method to add node or nodes if missing from our current list
|
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 181 of file vtkViewNode.h.
vtkMTimeType vtkViewNode::RenderTime |
Allows smart caching.
Definition at line 126 of file vtkViewNode.h.
|
staticprotected |
Definition at line 144 of file vtkViewNode.h.
|
protected |
Definition at line 176 of file vtkViewNode.h.
|
protected |
Definition at line 177 of file vtkViewNode.h.
|
protected |
Definition at line 178 of file vtkViewNode.h.
|
protected |
Definition at line 179 of file vtkViewNode.h.
|
protected |
Definition at line 180 of file vtkViewNode.h.
|
protected |
Definition at line 184 of file vtkViewNode.h.