a virtual light for 3D rendering More...

#include <vtkLight.h>

Inheritance diagram for vtkLight:

Collaboration diagram for vtkLight:

Public Types
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.

vtkLight *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual vtkLight *	ShallowClone ()
	Create a new light object with the same light parameters than the current object (any ivar from the superclasses (vtkObject and vtkObjectBase), like reference counting, timestamp and observers are not copied).

virtual void	Render (vtkRenderer *, int)
	Abstract interface to renderer.

void	TransformPoint (double a[3], double b[3])
	Use transform matrix to transform point (if it exists).

void	TransformVector (double a[3], double b[3])
	Use transform matrix to transform vector (if it exists).

void	DeepCopy (vtkLight *light)
	Perform deep copy of this light.


virtual void	SetAmbientColor (double, double, double)
	Set/Get the color of the light.

virtual void	SetAmbientColor (double[3])
	Set/Get the color of the light.

virtual double *	GetAmbientColor ()
	Set/Get the color of the light.

virtual void	GetAmbientColor (double data[3])
	Set/Get the color of the light.

virtual void	SetDiffuseColor (double, double, double)
	Set/Get the color of the light.

virtual void	SetDiffuseColor (double[3])
	Set/Get the color of the light.

virtual double *	GetDiffuseColor ()
	Set/Get the color of the light.

virtual void	GetDiffuseColor (double data[3])
	Set/Get the color of the light.

virtual void	SetSpecularColor (double, double, double)
	Set/Get the color of the light.

virtual void	SetSpecularColor (double[3])
	Set/Get the color of the light.

virtual double *	GetSpecularColor ()
	Set/Get the color of the light.

virtual void	GetSpecularColor (double data[3])
	Set/Get the color of the light.

void	SetColor (double, double, double)
	Set/Get the color of the light.

void	SetColor (const double a[3])
	Set/Get the color of the light.


virtual void	SetPosition (double, double, double)
	Set/Get the position of the light.

virtual void	SetPosition (double[3])
	Set/Get the position of the light.

virtual double *	GetPosition ()
	Set/Get the position of the light.

virtual void	GetPosition (double data[3])
	Set/Get the position of the light.

void	SetPosition (const float *a)
	Set/Get the position of the light.


virtual void	SetFocalPoint (double, double, double)
	Set/Get the point at which the light is shining.

virtual void	SetFocalPoint (double[3])
	Set/Get the point at which the light is shining.

virtual double *	GetFocalPoint ()
	Set/Get the point at which the light is shining.

virtual void	GetFocalPoint (double data[3])
	Set/Get the point at which the light is shining.

void	SetFocalPoint (const float *a)
	Set/Get the point at which the light is shining.


virtual void	SetIntensity (double)
	Set/Get the brightness of the light (from one to zero).

virtual double	GetIntensity ()
	Set/Get the brightness of the light (from one to zero).


virtual void	SetSwitch (vtkTypeBool)
	Turn the light on or off.

virtual vtkTypeBool	GetSwitch ()
	Turn the light on or off.

virtual void	SwitchOn ()
	Turn the light on or off.

virtual void	SwitchOff ()
	Turn the light on or off.


virtual void	SetPositional (vtkTypeBool)
	Turn positional lighting on or off.

virtual vtkTypeBool	GetPositional ()
	Turn positional lighting on or off.

virtual void	PositionalOn ()
	Turn positional lighting on or off.

virtual void	PositionalOff ()
	Turn positional lighting on or off.


virtual void	SetExponent (double)
	Set/Get the exponent of the cosine used in positional lighting.

virtual double	GetExponent ()
	Set/Get the exponent of the cosine used in positional lighting.


virtual void	SetConeAngle (double)
	Set/Get the lighting cone angle of a positional light in degrees.

virtual double	GetConeAngle ()
	Set/Get the lighting cone angle of a positional light in degrees.


virtual void	SetAttenuationValues (double, double, double)
	Set/Get the quadratic attenuation constants.

virtual void	SetAttenuationValues (double[3])
	Set/Get the quadratic attenuation constants.

virtual double *	GetAttenuationValues ()
	Set/Get the quadratic attenuation constants.

virtual void	GetAttenuationValues (double data[3])
	Set/Get the quadratic attenuation constants.


virtual void	SetTransformMatrix (vtkMatrix4x4 *)
	Set/Get the light's transformation matrix.

virtual vtkMatrix4x4 *	GetTransformMatrix ()
	Set/Get the light's transformation matrix.


void	GetTransformedPosition (double &x, double &y, double &z)
	Get the position of the light, modified by the transformation matrix (if it exists).

void	GetTransformedPosition (double a[3])
	Get the position of the light, modified by the transformation matrix (if it exists).

double *	GetTransformedPosition ()
	Get the position of the light, modified by the transformation matrix (if it exists).


void	GetTransformedFocalPoint (double &x, double &y, double &z)
	Get the focal point of the light, modified by the transformation matrix (if it exists).

void	GetTransformedFocalPoint (double a[3])
	Get the focal point of the light, modified by the transformation matrix (if it exists).

double *	GetTransformedFocalPoint ()
	Get the focal point of the light, modified by the transformation matrix (if it exists).


void	SetDirectionAngle (double elevation, double azimuth)
	Set the position and focal point of a light based on elevation and azimuth.

void	SetDirectionAngle (const double ang[2])
	Set the position and focal point of a light based on elevation and azimuth.


virtual void	SetLightType (int)
	Set/Get the type of the light.

virtual int	GetLightType ()
	Set/Get the type of the light.

void	SetLightTypeToHeadlight ()
	Set/Get the type of the light.

void	SetLightTypeToSceneLight ()
	Set/Get the type of the light.

void	SetLightTypeToCameraLight ()
	Set/Get the type of the light.


int	LightTypeIsHeadlight ()
	Query the type of the light.

int	LightTypeIsSceneLight ()
	Query the type of the light.

int	LightTypeIsCameraLight ()
	Query the type of the light.


virtual void	SetShadowAttenuation (float)
	Set/Get the shadow intensity By default a light will be completely blocked when in shadow by setting this value to less than 1.0 you can control how much light is attenuated when in shadow.

virtual float	GetShadowAttenuation ()
	Set/Get the shadow intensity By default a light will be completely blocked when in shadow by setting this value to less than 1.0 you can control how much light is attenuated when in shadow.


virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with the light.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with the light.

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 vtkLight *	SafeDownCast (vtkObjectBase *o)

static vtkLight *	New ()
	Create a light with the focal point at the origin and its position set to (0,0,1).

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLight ()

	~vtkLight () override

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
double	FocalPoint [3]

double	Position [3]

double	Intensity

double	AmbientColor [3]

double	DiffuseColor [3]

double	SpecularColor [3]

vtkTypeBool	Switch

vtkTypeBool	Positional

double	Exponent

double	ConeAngle

double	AttenuationValues [3]

vtkMatrix4x4 *	TransformMatrix

double	TransformedFocalPointReturn [3]

double	TransformedPositionReturn [3]

int	LightType

float	ShadowAttenuation

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

a virtual light for 3D rendering

vtkLight is a virtual light for 3D rendering. It provides methods to locate and point the light, turn it on and off, and set its brightness and color. In addition to the basic infinite distance point light source attributes, you also can specify the light attenuation values and cone angle. These attributes are only used if the light is a positional light. The default is a directional light (e.g. infinite point light source).

Lights have a type that describes how the light should move with respect to the camera. A Headlight is always located at the current camera position and shines on the camera's focal point. A CameraLight also moves with the camera, but may not be coincident to it. CameraLights are defined in a normalized coordinate space where the camera is located at (0, 0, 1), the camera is looking at (0, 0, 0), and up is (0, 1, 0). Finally, a SceneLight is part of the scene itself and does not move with the camera. (Renderers are responsible for moving the light based on its type.)

Lights have a transformation matrix that describes the space in which they are positioned. A light's world space position and focal point are defined by their local position and focal point, transformed by their transformation matrix (if it exists).

Online Examples:

Definition at line 165 of file vtkLight.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkLight::Superclass

Definition at line 168 of file vtkLight.h.

Constructor & Destructor Documentation

◆ vtkLight()

vtkLight::vtkLight ( )

protected

◆ ~vtkLight()

vtkLight::~vtkLight ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkLight::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 vtkObjectBase.

Reimplemented in vtkRIBLight, vtkExternalLight, and vtkOpenGLLight.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkLight::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkRIBLight, vtkExternalLight, and vtkOpenGLLight.

◆ NewInstance()

vtkLight * vtkLight::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkExternalLight, and vtkOpenGLLight.

◆ New()

static vtkLight * vtkLight::New ( )

static

Create a light with the focal point at the origin and its position set to (0,0,1).

The light is a SceneLight, its color is white (black ambient, white diffuse, white specular), intensity=1, the light is turned on, positional lighting is off, ConeAngle=30, AttenuationValues=(1,0,0), Exponent=1 and the TransformMatrix is NULL.

◆ ShallowClone()

virtual vtkLight * vtkLight::ShallowClone ( )

virtual

Create a new light object with the same light parameters than the current object (any ivar from the superclasses (vtkObject and vtkObjectBase), like reference counting, timestamp and observers are not copied).

This is a shallow clone (TransformMatrix is referenced)

◆ Render()

virtual void vtkLight::Render	(	vtkRenderer *	,
		int
	)

inlinevirtual

Abstract interface to renderer.

Each concrete subclass of vtkLight will load its data into the graphics system in response to this method invocation. The actual loading is performed by a vtkLightDevice subclass, which will get created automatically.

Reimplemented in vtkRIBLight, and vtkOpenGLLight.

Definition at line 195 of file vtkLight.h.