VTK  9.0.20201029
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkOSPRayActorNode Class Reference

links vtkActor and vtkMapper to OSPRay More...

#include <vtkOSPRayActorNode.h>

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

Public Types

enum  ScalingMode { ALL_EXACT = -1, ALL_APPROXIMATE, EACH_MAPPED, EACH_EXACT }
 Scaling modes for the spheres and cylinders that the raytracer renders for points and lines created by VTK. More...
 
typedef vtkActorNode Superclass
 
- Public Types inherited from vtkActorNode
typedef vtkViewNode Superclass
 
- Public Types inherited from vtkViewNode
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...
 
vtkOSPRayActorNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Overridden to take into account my renderables time, including mapper and data into mapper inclusive of composite input. More...
 
- Public Member Functions inherited from vtkActorNode
vtkActorNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Build (bool prepass) override
 Build containers for our child nodes. More...
 
- Public Member Functions inherited from vtkViewNode
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 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 std::list< vtkViewNode * > const & GetChildren ()
 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 ()
 
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...
 
vtkViewNodeGetFirstChildOfType (const char *type)
 Find the first child 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...
 
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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkOSPRayActorNodeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOSPRayActorNodeSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyENABLE_SCALING ()
 A key to set the ScalingMode. More...
 
static void SetEnableScaling (int value, vtkActor *)
 Convenience method to set enable_scaling on my renderable. More...
 
static int GetEnableScaling (vtkActor *)
 
static vtkInformationStringKeySCALE_ARRAY_NAME ()
 Name of a point aligned, single component wide, double valued array that, when added to the mapper, will be used to scale each element in the sphere and cylinder representations individually. More...
 
static void SetScaleArrayName (const char *scaleArrayName, vtkActor *)
 Convenience method to set a scale_array_name on my renderable. More...
 
static vtkInformationObjectBaseKeySCALE_FUNCTION ()
 A piecewise function for values from the scale array that alters the resulting radii arbitrarily. More...
 
static void SetScaleFunction (vtkPiecewiseFunction *scaleFunction, vtkActor *)
 Convenience method to set a scale_function on my renderable. More...
 
static vtkInformationDoubleKeyLUMINOSITY ()
 Indicates that the actor acts as a light emitting object. More...
 
static void SetLuminosity (double value, vtkProperty *)
 Convenience method to set luminosity on my renderable. More...
 
static double GetLuminosity (vtkProperty *)
 
- Static Public Member Functions inherited from vtkActorNode
static vtkActorNodeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkActorNodeSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkViewNode
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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOSPRayActorNode ()
 
 ~vtkOSPRayActorNode () override
 
- Protected Member Functions inherited from vtkActorNode
 vtkActorNode ()
 
 ~vtkActorNode () override
 
- Protected Member Functions inherited from vtkViewNode
 vtkViewNode ()
 
 ~vtkViewNode () override
 
virtual 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Public Attributes inherited from vtkViewNode
vtkMTimeType RenderTime
 Allows smart caching. More...
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Protected Attributes inherited from vtkViewNode
vtkObjectRenderable
 
vtkWeakPointer< vtkViewNodeParent
 
std::list< vtkViewNode * > Children
 
vtkViewNodeFactoryMyFactory
 
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 inherited from vtkViewNode
static const char * operation_type_strings []
 

Detailed Description

links vtkActor and vtkMapper to OSPRay

Translates vtkActor/Mapper state into OSPRay rendering calls

Definition at line 43 of file vtkOSPRayActorNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkOSPRayActorNode.h.

Member Enumeration Documentation

◆ ScalingMode

Scaling modes for the spheres and cylinders that the raytracer renders for points and lines created by VTK.

Enumerator
ALL_EXACT 
ALL_APPROXIMATE 
EACH_MAPPED 
EACH_EXACT 

Definition at line 60 of file vtkOSPRayActorNode.h.

Constructor & Destructor Documentation

◆ vtkOSPRayActorNode()

vtkOSPRayActorNode::vtkOSPRayActorNode ( )
protected

◆ ~vtkOSPRayActorNode()

vtkOSPRayActorNode::~vtkOSPRayActorNode ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkOSPRayActorNode* vtkOSPRayActorNode::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOSPRayActorNode::IsA ( const char *  name)
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 vtkActorNode.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOSPRayActorNode::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkActorNode.

◆ NewInstance()

vtkOSPRayActorNode* vtkOSPRayActorNode::NewInstance ( ) const

◆ PrintSelf()

void vtkOSPRayActorNode::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.

◆ GetMTime()

vtkMTimeType vtkOSPRayActorNode::GetMTime ( )
overridevirtual

Overridden to take into account my renderables time, including mapper and data into mapper inclusive of composite input.

Reimplemented from vtkObject.

◆ ENABLE_SCALING()

static vtkInformationIntegerKey* vtkOSPRayActorNode::ENABLE_SCALING ( )
static

A key to set the ScalingMode.

The default is ALL_APPROXIMATE. ALL_EXACT means use vtkActor.PointSize/LineWidth for all radii. ALL_APPROXIMATE sets all radii to approximate GL's pixel sizes via a function of PointSize/LineWidth and object bounding box. EACH_MAPPED means map every value from SCALE_ARRAY_NAME through the SCALE_FUNCTION lookup table to set each radius independently. EACH_EXACT means use the SCALE_ARRAY_NAME to set each radius directly.

◆ SetEnableScaling()

static void vtkOSPRayActorNode::SetEnableScaling ( int  value,
vtkActor  
)
static

Convenience method to set enable_scaling on my renderable.

◆ GetEnableScaling()

static int vtkOSPRayActorNode::GetEnableScaling ( vtkActor )
static

◆ SCALE_ARRAY_NAME()

static vtkInformationStringKey* vtkOSPRayActorNode::SCALE_ARRAY_NAME ( )
static

Name of a point aligned, single component wide, double valued array that, when added to the mapper, will be used to scale each element in the sphere and cylinder representations individually.

When not supplied the radius is constant across all elements and is a function of the Mapper's PointSize and LineWidth.

◆ SetScaleArrayName()

static void vtkOSPRayActorNode::SetScaleArrayName ( const char *  scaleArrayName,
vtkActor  
)
static

Convenience method to set a scale_array_name on my renderable.

◆ SCALE_FUNCTION()

static vtkInformationObjectBaseKey* vtkOSPRayActorNode::SCALE_FUNCTION ( )
static

A piecewise function for values from the scale array that alters the resulting radii arbitrarily.

◆ SetScaleFunction()

static void vtkOSPRayActorNode::SetScaleFunction ( vtkPiecewiseFunction scaleFunction,
vtkActor  
)
static

Convenience method to set a scale_function on my renderable.

◆ LUMINOSITY()

static vtkInformationDoubleKey* vtkOSPRayActorNode::LUMINOSITY ( )
static

Indicates that the actor acts as a light emitting object.

◆ SetLuminosity()

static void vtkOSPRayActorNode::SetLuminosity ( double  value,
vtkProperty  
)
static

Convenience method to set luminosity on my renderable.

◆ GetLuminosity()

static double vtkOSPRayActorNode::GetLuminosity ( vtkProperty )
static

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