VTK  9.3.20240724
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkAnariLightNode Class Reference

links vtkLights to ANARI More...

#include <vtkAnariLightNode.h>

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

Public Types

typedef vtkLightNode Superclass
 
- Public Types inherited from vtkLightNode
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.
 
vtkAnariLightNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Build (bool prepass) override
 Ensure the right type of ANARICamera object is being held.
 
void Synchronize (bool prepass) override
 Sync ANARICamera parameters with vtkCamera.
 
virtual void Render (bool prepass) override
 Make ANARI calls to render me.
 
virtual void Invalidate (bool prepass) override
 Invalidates cached rendering data.
 
- Public Member Functions inherited from vtkLightNode
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkLightNodeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
- Public Member Functions inherited from vtkViewNode
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkViewNodeNewInstance () 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.
 
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.
 
vtkViewNodeGetFirstAncestorOfType (const char *type)
 Find the first parent/grandparent of the desired type.
 
vtkViewNodeGetFirstChildOfType (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 vtkObjectGetRenderable ()
 This is the VTK class that this node stands in for.
 
virtual void SetParent (vtkViewNode *)
 Access the node that owns this one.
 
virtual vtkViewNodeGetParent ()
 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 vtkViewNodeFactoryGetMyFactory ()
 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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
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.
 
vtkCommandGetCommand (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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
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.
 
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.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkAnariLightNodeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAnariLightNodeSafeDownCast (vtkObjectBase *o)
 
static vtkInformationDoubleKeyLIGHT_SCALE ()
 A global multiplier to all ANARI lights.
 
static vtkInformationIntegerKeyIS_AMBIENT ()
 When present on light, the light acts as an ambient source.
 
static void SetIsAmbient (int, vtkLight *)
 Convenience method to set/get IS_AMBIENT on a vtkLight.
 
static int GetIsAmbient (vtkLight *)
 
static vtkInformationDoubleKeyRADIUS ()
 The radius setting, when > 0.0, produces soft shadows in the path tracer.
 
static void SetRadius (double, vtkLight *)
 Convenience method to set/get RADIUS on a vtkLight.
 
static double GetRadius (vtkLight *)
 
static vtkInformationDoubleKeyFALLOFF_ANGLE ()
 For cone-shaped lights, size (angle in radians) of the region between the rim (of the illumination cone) and full intensity of the spot; should be smaller than half of openingAngle.
 
static void SetFalloffAngle (double, vtkLight *)
 Convenience method to set/get FALLOFF_ANGLE on a vtkLight.
 
static double GetFalloffAngle (vtkLight *)
 
static void SetLightScale (double, vtkLight *)
 Convenience method to set/get LIGHT_SCALE on a vtkLight.
 
static double GetLightScale (vtkLight *)
 Convenience method to set/get LIGHT_SCALE on a vtkLight.
 
- Static Public Member Functions inherited from vtkLightNode
static vtkLightNodeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLightNodeSafeDownCast (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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool 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 vtkTypeBool 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 vtkObjectBaseNew ()
 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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAnariLightNode ()
 
 ~vtkAnariLightNode ()
 
- Protected Member Functions inherited from vtkLightNode
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLightNode ()
 
 ~vtkLightNode () override
 
- Protected Member Functions inherited from vtkViewNode
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkViewNode ()
 
 ~vtkViewNode () override
 
virtual void Apply (int operation, bool prepass)
 
void RemoveUnusedNodes ()
 Called after PrepareNodes and AddMissingNodes removes any extra leftover nodes.
 
virtual vtkViewNodeCreateViewNode (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 *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Public Attributes inherited from vtkViewNode
vtkMTimeType RenderTime
 Allows smart caching.
 
- 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
 
std::string ObjectName
 
- 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 vtkLights to ANARI

Translates vtkLight state into ANARILight state. Lights in ANARI are virtual objects that emit light into the world and thus illuminate objects.

Thanks:
Kevin Griffin kgrif.nosp@m.fin@.nosp@m.nvidi.nosp@m.a.co.nosp@m.m for creating and contributing the class and NVIDIA for supporting this work.
Tests:
vtkAnariLightNode (Tests)

Definition at line 33 of file vtkAnariLightNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkAnariLightNode.h.

Constructor & Destructor Documentation

◆ vtkAnariLightNode()

vtkAnariLightNode::vtkAnariLightNode ( )
protected

◆ ~vtkAnariLightNode()

vtkAnariLightNode::~vtkAnariLightNode ( )
protected

Member Function Documentation

◆ New()

static vtkAnariLightNode * vtkAnariLightNode::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAnariLightNode::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 vtkLightNode.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkAnariLightNode::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkLightNode.

◆ NewInstance()

vtkAnariLightNode * vtkAnariLightNode::NewInstance ( ) const

◆ PrintSelf()

void vtkAnariLightNode::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 vtkObjectBase.

◆ Build()

void vtkAnariLightNode::Build ( bool  prepass)
overridevirtual

Ensure the right type of ANARICamera object is being held.

Reimplemented from vtkViewNode.

◆ Synchronize()

void vtkAnariLightNode::Synchronize ( bool  prepass)
overridevirtual

Sync ANARICamera parameters with vtkCamera.

Reimplemented from vtkViewNode.

◆ Render()

virtual void vtkAnariLightNode::Render ( bool  prepass)
overridevirtual

Make ANARI calls to render me.

Reimplemented from vtkViewNode.

◆ Invalidate()

virtual void vtkAnariLightNode::Invalidate ( bool  prepass)
overridevirtual

Invalidates cached rendering data.

Reimplemented from vtkViewNode.

◆ LIGHT_SCALE()

static vtkInformationDoubleKey * vtkAnariLightNode::LIGHT_SCALE ( )
static

A global multiplier to all ANARI lights.

default is 1.0

◆ SetLightScale()

static void vtkAnariLightNode::SetLightScale ( double  ,
vtkLight  
)
static

Convenience method to set/get LIGHT_SCALE on a vtkLight.

◆ GetLightScale()

static double vtkAnariLightNode::GetLightScale ( vtkLight )
static

Convenience method to set/get LIGHT_SCALE on a vtkLight.

◆ IS_AMBIENT()

static vtkInformationIntegerKey * vtkAnariLightNode::IS_AMBIENT ( )
static

When present on light, the light acts as an ambient source.

An AmbientLight is one that has no specific position in space and for which only the ambient color term affects the result.

◆ SetIsAmbient()

static void vtkAnariLightNode::SetIsAmbient ( int  ,
vtkLight  
)
static

Convenience method to set/get IS_AMBIENT on a vtkLight.

◆ GetIsAmbient()

static int vtkAnariLightNode::GetIsAmbient ( vtkLight )
static

◆ RADIUS()

static vtkInformationDoubleKey * vtkAnariLightNode::RADIUS ( )
static

The radius setting, when > 0.0, produces soft shadows in the path tracer.

◆ SetRadius()

static void vtkAnariLightNode::SetRadius ( double  ,
vtkLight  
)
static

Convenience method to set/get RADIUS on a vtkLight.

◆ GetRadius()

static double vtkAnariLightNode::GetRadius ( vtkLight )
static

◆ FALLOFF_ANGLE()

static vtkInformationDoubleKey * vtkAnariLightNode::FALLOFF_ANGLE ( )
static

For cone-shaped lights, size (angle in radians) of the region between the rim (of the illumination cone) and full intensity of the spot; should be smaller than half of openingAngle.

◆ SetFalloffAngle()

static void vtkAnariLightNode::SetFalloffAngle ( double  ,
vtkLight  
)
static

Convenience method to set/get FALLOFF_ANGLE on a vtkLight.

◆ GetFalloffAngle()

static double vtkAnariLightNode::GetFalloffAngle ( vtkLight )
static

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