vtkLightNode Class Reference

vtkViewNode specialized for vtkLights More...

#include <vtkLightNode.h>

Inheritance diagram for vtkLightNode:

Collaboration diagram for vtkLightNode:

Public Types
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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkLightNode *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
Public Member Functions inherited from vtkViewNode
vtkViewNode *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. 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...
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 *)
	Alow explicit setting of the renderable for a view node. More...
virtual void	Traverse (int operation)
virtual void	TraverseAllPasses ()
virtual vtkObject *	GetRenderable ()
	This is the VTK class that this node stands in for. More...
virtual void	SetParent (vtkViewNode *)
	Access the node that owns this one. More...
virtual vtkViewNode *	GetParent ()
	Access the node that owns this one. More...
virtual void	SetChildren (vtkViewNodeCollection *)
	Access nodes that this one owns. More...
virtual vtkViewNodeCollection *	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 vtkViewNodeFactory *	GetMyFactory ()
	A factory that creates particular subclasses for different rendering back ends. More...
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...
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	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. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...
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	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...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkLightNode *	New ()
static int	IsTypeOf (const char *type)
static vtkLightNode *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkViewNode
static int	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. 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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkLightNode ()
	~vtkLightNode ()
Protected Member Functions inherited from vtkViewNode
	vtkViewNode ()
	~vtkViewNode ()
void	Apply (int operation, bool prepass)
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...
void	AddMissingNode (vtkObject *obj)
	convienience method to add node or nodes if missing from our current list More...
void	AddMissingNodes (vtkCollection *col)
	convienience method to add node or nodes if missing from our current list More...
void	PrepareNodes ()
	Called first before adding missing nodes. 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=NULL)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
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...
Protected Attributes inherited from vtkViewNode
vtkObject *	Renderable
vtkWeakPointer< vtkViewNode >	Parent
vtkViewNodeCollection *	Children
vtkViewNodeFactory *	MyFactory
vtkCollection *	PreparedNodes
	Called first before adding missing nodes. More...
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Static Protected Attributes inherited from vtkViewNode
static const char *	operation_type_strings []

Detailed Description

vtkViewNode specialized for vtkLights

State storage and graph traversal for vtkLight

Tests:

vtkLightNode (Tests)

Definition at line 31 of file vtkLightNode.h.

Member Typedef Documentation

typedef vtkViewNode vtkLightNode::Superclass

Definition at line 36 of file vtkLightNode.h.

Constructor & Destructor Documentation

vtkLightNode::vtkLightNode ( )

protected

vtkLightNode::~vtkLightNode ( )

protected

Member Function Documentation

static vtkLightNode* vtkLightNode::New ( )

static

static int vtkLightNode::IsTypeOf ( const char *  type )

static

virtual int vtkLightNode::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 vtkViewNode.

Reimplemented in vtkOSPRayLightNode.

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

static

virtual vtkObjectBase* vtkLightNode::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkViewNode.

Reimplemented in vtkOSPRayLightNode.

vtkLightNode* vtkLightNode::NewInstance

(

)

const

void vtkLightNode::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

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.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/SceneGraph/vtkLightNode.h