vtkLight Class Reference

#include <vtkLight.h>

Inheritance diagram for vtkLight:

Inheritance graph
[legend]
Collaboration diagram for vtkLight:

Collaboration graph
[legend]

List of all members.


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).

Examples:
vtkLight (Examples)
Tests:
vtkLight (Tests)

Definition at line 59 of file vtkLight.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkLightShallowClone ()
virtual void Render (vtkRenderer *, int)
void DeepCopy (vtkLight *light)
void ReadSelf (istream &is)
void WriteSelf (ostream &os)
virtual void SetAmbientColor (double, double, double)
virtual void SetAmbientColor (double[3])
virtual double * GetAmbientColor ()
virtual void GetAmbientColor (double data[3])
virtual void SetDiffuseColor (double, double, double)
virtual void SetDiffuseColor (double[3])
virtual double * GetDiffuseColor ()
virtual void GetDiffuseColor (double data[3])
virtual void SetSpecularColor (double, double, double)
virtual void SetSpecularColor (double[3])
virtual double * GetSpecularColor ()
virtual void GetSpecularColor (double data[3])
void SetColor (double, double, double)
void SetColor (double a[3])
void GetColor (double rgb[3])
double * GetColor ()
virtual void SetPosition (double, double, double)
virtual void SetPosition (double[3])
virtual double * GetPosition ()
virtual void GetPosition (double data[3])
void SetPosition (float *a)
virtual void SetFocalPoint (double, double, double)
virtual void SetFocalPoint (double[3])
virtual double * GetFocalPoint ()
virtual void GetFocalPoint (double data[3])
void SetFocalPoint (float *a)
virtual void SetIntensity (double)
virtual double GetIntensity ()
virtual void SetSwitch (int)
virtual int GetSwitch ()
virtual void SwitchOn ()
virtual void SwitchOff ()
virtual void SetPositional (int)
virtual int GetPositional ()
virtual void PositionalOn ()
virtual void PositionalOff ()
virtual void SetExponent (double)
virtual double GetExponent ()
virtual void SetConeAngle (double)
virtual double GetConeAngle ()
virtual void SetAttenuationValues (double, double, double)
virtual void SetAttenuationValues (double[3])
virtual double * GetAttenuationValues ()
virtual void GetAttenuationValues (double data[3])
virtual void SetTransformMatrix (vtkMatrix4x4 *)
virtual vtkMatrix4x4GetTransformMatrix ()
void GetTransformedPosition (double &a0, double &a1, double &a2)
void GetTransformedPosition (double a[3])
double * GetTransformedPosition ()
void GetTransformedFocalPoint (double &a0, double &a1, double &a2)
void GetTransformedFocalPoint (double a[3])
double * GetTransformedFocalPoint ()
void SetDirectionAngle (double elevation, double azimuth)
void SetDirectionAngle (double ang[2])
virtual void SetLightType (int)
virtual int GetLightType ()
void SetLightTypeToHeadlight ()
void SetLightTypeToSceneLight ()
void SetLightTypeToCameraLight ()
int LightTypeIsHeadlight ()
int LightTypeIsSceneLight ()
int LightTypeIsCameraLight ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkLightSafeDownCast (vtkObject *o)
static vtkLightNew ()

Protected Member Functions

 vtkLight ()
 ~vtkLight ()

Protected Attributes

double FocalPoint [3]
double Position [3]
double Intensity
double AmbientColor [3]
double DiffuseColor [3]
double SpecularColor [3]
int Switch
int Positional
double Exponent
double ConeAngle
double AttenuationValues [3]
vtkMatrix4x4TransformMatrix
double TransformedFocalPointReturn [3]
double TransformedPositionReturn [3]
int LightType

Member Typedef Documentation

Reimplemented from vtkObject.

Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight.

Definition at line 62 of file vtkLight.h.


Constructor & Destructor Documentation

vtkLight::vtkLight (  )  [protected]

vtkLight::~vtkLight (  )  [protected]


Member Function Documentation

virtual const char* vtkLight::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight.

static int vtkLight::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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 vtkObject.

Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight.

virtual int 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 vtkObject.

Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight.

static vtkLight* vtkLight::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight.

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

Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight.

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.

Reimplemented from vtkObject.

Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight.

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)

virtual void vtkLight::Render ( vtkRenderer ,
int   
) [inline, virtual]

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, vtkMesaLight, and vtkOpenGLLight.

Definition at line 83 of file vtkLight.h.

virtual void vtkLight::SetAmbientColor ( double  ,
double  ,
double   
) [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::SetAmbientColor ( double  [3]  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual double* vtkLight::GetAmbientColor (  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::GetAmbientColor ( double  data[3]  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::SetDiffuseColor ( double  ,
double  ,
double   
) [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::SetDiffuseColor ( double  [3]  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual double* vtkLight::GetDiffuseColor (  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::GetDiffuseColor ( double  data[3]  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::SetSpecularColor ( double  ,
double  ,
double   
) [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::SetSpecularColor ( double  [3]  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual double* vtkLight::GetSpecularColor (  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

virtual void vtkLight::GetSpecularColor ( double  data[3]  )  [virtual]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

void vtkLight::SetColor ( double  ,
double  ,
double   
)

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

void vtkLight::SetColor ( double  a[3]  )  [inline]

Set/Get the color of the light. It is possible to set the ambient, diffuse and specular colors separately. The SetColor() method sets the diffuse and specular colors to the same color (this is a feature to preserve backward compatbility.)

Definition at line 97 of file vtkLight.h.

void vtkLight::GetColor ( double  rgb[3]  ) 

Deprecated:
Use GetDiffuseColor instead as of VTK 5.7.

double* vtkLight::GetColor (  ) 

Deprecated:
Use GetDiffuseColor instead as of VTK 5.7.

virtual void vtkLight::SetPosition ( double  ,
double  ,
double   
) [virtual]

Set/Get the position of the light. Note: The position of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space position, use vtkGetTransformedPosition() instead of vtkGetPosition().

virtual void vtkLight::SetPosition ( double  [3]  )  [virtual]

Set/Get the position of the light. Note: The position of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space position, use vtkGetTransformedPosition() instead of vtkGetPosition().

virtual double* vtkLight::GetPosition (  )  [virtual]

Set/Get the position of the light. Note: The position of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space position, use vtkGetTransformedPosition() instead of vtkGetPosition().

virtual void vtkLight::GetPosition ( double  data[3]  )  [virtual]

Set/Get the position of the light. Note: The position of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space position, use vtkGetTransformedPosition() instead of vtkGetPosition().

void vtkLight::SetPosition ( float *  a  )  [inline]

Set/Get the position of the light. Note: The position of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space position, use vtkGetTransformedPosition() instead of vtkGetPosition().

Definition at line 113 of file vtkLight.h.

virtual void vtkLight::SetFocalPoint ( double  ,
double  ,
double   
) [virtual]

Set/Get the point at which the light is shining. Note: The focal point of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space focal point, use vtkGetTransformedFocalPoint() instead of vtkGetFocalPoint().

virtual void vtkLight::SetFocalPoint ( double  [3]  )  [virtual]

Set/Get the point at which the light is shining. Note: The focal point of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space focal point, use vtkGetTransformedFocalPoint() instead of vtkGetFocalPoint().

virtual double* vtkLight::GetFocalPoint (  )  [virtual]

Set/Get the point at which the light is shining. Note: The focal point of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space focal point, use vtkGetTransformedFocalPoint() instead of vtkGetFocalPoint().

virtual void vtkLight::GetFocalPoint ( double  data[3]  )  [virtual]

Set/Get the point at which the light is shining. Note: The focal point of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space focal point, use vtkGetTransformedFocalPoint() instead of vtkGetFocalPoint().

void vtkLight::SetFocalPoint ( float *  a  )  [inline]

Set/Get the point at which the light is shining. Note: The focal point of the light is defined in the coordinate space indicated by its transformation matrix (if it exists). Thus, to get the light's world space focal point, use vtkGetTransformedFocalPoint() instead of vtkGetFocalPoint().

Definition at line 124 of file vtkLight.h.

virtual void vtkLight::SetIntensity ( double   )  [virtual]

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

virtual double vtkLight::GetIntensity (  )  [virtual]

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

virtual void vtkLight::SetSwitch ( int   )  [virtual]

Turn the light on or off.

virtual int vtkLight::GetSwitch (  )  [virtual]

Turn the light on or off.

virtual void vtkLight::SwitchOn (  )  [virtual]

Turn the light on or off.

virtual void vtkLight::SwitchOff (  )  [virtual]

Turn the light on or off.

virtual void vtkLight::SetPositional ( int   )  [virtual]

Turn positional lighting on or off.

virtual int vtkLight::GetPositional (  )  [virtual]

Turn positional lighting on or off.

virtual void vtkLight::PositionalOn (  )  [virtual]

Turn positional lighting on or off.

virtual void vtkLight::PositionalOff (  )  [virtual]

Turn positional lighting on or off.

virtual void vtkLight::SetExponent ( double   )  [virtual]

Set/Get the exponent of the cosine used in positional lighting.

virtual double vtkLight::GetExponent (  )  [virtual]

Set/Get the exponent of the cosine used in positional lighting.

virtual void vtkLight::SetConeAngle ( double   )  [virtual]

Set/Get the lighting cone angle of a positional light in degrees. This is the angle between the axis of the cone and a ray along the edge of the cone. A value of 180 indicates that you want no spot lighting effects just a positional light.

virtual double vtkLight::GetConeAngle (  )  [virtual]

Set/Get the lighting cone angle of a positional light in degrees. This is the angle between the axis of the cone and a ray along the edge of the cone. A value of 180 indicates that you want no spot lighting effects just a positional light.

virtual void vtkLight::SetAttenuationValues ( double  ,
double  ,
double   
) [virtual]

Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.

virtual void vtkLight::SetAttenuationValues ( double  [3]  )  [virtual]

Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.

virtual double* vtkLight::GetAttenuationValues (  )  [virtual]

Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.

virtual void vtkLight::GetAttenuationValues ( double  data[3]  )  [virtual]

Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.

virtual void vtkLight::SetTransformMatrix ( vtkMatrix4x4  )  [virtual]

Set/Get the light's transformation matrix. If a matrix is set for a light, the light's parameters (position and focal point) are transformed by the matrix before being rendered.

virtual vtkMatrix4x4* vtkLight::GetTransformMatrix (  )  [virtual]

Set/Get the light's transformation matrix. If a matrix is set for a light, the light's parameters (position and focal point) are transformed by the matrix before being rendered.

void vtkLight::GetTransformedPosition ( double &  a0,
double &  a1,
double &  a2 
)

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

void vtkLight::GetTransformedPosition ( double  a[3]  ) 

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

double* vtkLight::GetTransformedPosition (  ) 

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

void vtkLight::GetTransformedFocalPoint ( double &  a0,
double &  a1,
double &  a2 
)

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

void vtkLight::GetTransformedFocalPoint ( double  a[3]  ) 

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

double* vtkLight::GetTransformedFocalPoint (  ) 

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

void vtkLight::SetDirectionAngle ( double  elevation,
double  azimuth 
)

Set the position and focal point of a light based on elevation and azimuth. The light is moved so it is shining from the given angle. Angles are given in degrees. If the light is a positional light, it is made directional instead.

void vtkLight::SetDirectionAngle ( double  ang[2]  )  [inline]

Set the position and focal point of a light based on elevation and azimuth. The light is moved so it is shining from the given angle. Angles are given in degrees. If the light is a positional light, it is made directional instead.

Definition at line 199 of file vtkLight.h.

void vtkLight::DeepCopy ( vtkLight light  ) 

Perform deep copy of this light.

virtual void vtkLight::SetLightType ( int   )  [virtual]

Set/Get the type of the light. A SceneLight is a light located in the world coordinate space. A light is initially created as a scene light. A Headlight is always located at the camera and is pointed at the camera's focal point. The renderer is free to modify the position and focal point of the camera at any time. A CameraLight is also attached to the camera, but is not necessarily located at the camera's position. CameraLights are defined in a coordinate space where the camera is located at (0, 0, 1), looking towards (0, 0, 0) at a distance of 1, with up being (0, 1, 0). Note: Use SetLightTypeToSceneLight, rather than SetLightType(3), since the former clears the light's transform matrix.

virtual int vtkLight::GetLightType (  )  [virtual]

Set/Get the type of the light. A SceneLight is a light located in the world coordinate space. A light is initially created as a scene light. A Headlight is always located at the camera and is pointed at the camera's focal point. The renderer is free to modify the position and focal point of the camera at any time. A CameraLight is also attached to the camera, but is not necessarily located at the camera's position. CameraLights are defined in a coordinate space where the camera is located at (0, 0, 1), looking towards (0, 0, 0) at a distance of 1, with up being (0, 1, 0). Note: Use SetLightTypeToSceneLight, rather than SetLightType(3), since the former clears the light's transform matrix.

void vtkLight::SetLightTypeToHeadlight (  )  [inline]

Set/Get the type of the light. A SceneLight is a light located in the world coordinate space. A light is initially created as a scene light. A Headlight is always located at the camera and is pointed at the camera's focal point. The renderer is free to modify the position and focal point of the camera at any time. A CameraLight is also attached to the camera, but is not necessarily located at the camera's position. CameraLights are defined in a coordinate space where the camera is located at (0, 0, 1), looking towards (0, 0, 0) at a distance of 1, with up being (0, 1, 0). Note: Use SetLightTypeToSceneLight, rather than SetLightType(3), since the former clears the light's transform matrix.

Definition at line 220 of file vtkLight.h.

void vtkLight::SetLightTypeToSceneLight (  )  [inline]

Set/Get the type of the light. A SceneLight is a light located in the world coordinate space. A light is initially created as a scene light. A Headlight is always located at the camera and is pointed at the camera's focal point. The renderer is free to modify the position and focal point of the camera at any time. A CameraLight is also attached to the camera, but is not necessarily located at the camera's position. CameraLights are defined in a coordinate space where the camera is located at (0, 0, 1), looking towards (0, 0, 0) at a distance of 1, with up being (0, 1, 0). Note: Use SetLightTypeToSceneLight, rather than SetLightType(3), since the former clears the light's transform matrix.

Definition at line 222 of file vtkLight.h.

void vtkLight::SetLightTypeToCameraLight (  )  [inline]

Set/Get the type of the light. A SceneLight is a light located in the world coordinate space. A light is initially created as a scene light. A Headlight is always located at the camera and is pointed at the camera's focal point. The renderer is free to modify the position and focal point of the camera at any time. A CameraLight is also attached to the camera, but is not necessarily located at the camera's position. CameraLights are defined in a coordinate space where the camera is located at (0, 0, 1), looking towards (0, 0, 0) at a distance of 1, with up being (0, 1, 0). Note: Use SetLightTypeToSceneLight, rather than SetLightType(3), since the former clears the light's transform matrix.

Definition at line 227 of file vtkLight.h.

int vtkLight::LightTypeIsHeadlight (  ) 

Query the type of the light.

int vtkLight::LightTypeIsSceneLight (  ) 

Query the type of the light.

int vtkLight::LightTypeIsCameraLight (  ) 

Query the type of the light.

void vtkLight::ReadSelf ( istream &  is  ) 

void vtkLight::WriteSelf ( ostream &  os  ) 


Member Data Documentation

double vtkLight::FocalPoint[3] [protected]

Definition at line 245 of file vtkLight.h.

double vtkLight::Position[3] [protected]

Definition at line 246 of file vtkLight.h.

double vtkLight::Intensity [protected]

Definition at line 247 of file vtkLight.h.

double vtkLight::AmbientColor[3] [protected]

Definition at line 248 of file vtkLight.h.

double vtkLight::DiffuseColor[3] [protected]

Definition at line 249 of file vtkLight.h.

double vtkLight::SpecularColor[3] [protected]

Definition at line 250 of file vtkLight.h.

int vtkLight::Switch [protected]

Definition at line 251 of file vtkLight.h.

int vtkLight::Positional [protected]

Definition at line 252 of file vtkLight.h.

double vtkLight::Exponent [protected]

Definition at line 253 of file vtkLight.h.

double vtkLight::ConeAngle [protected]

Definition at line 254 of file vtkLight.h.

double vtkLight::AttenuationValues[3] [protected]

Definition at line 255 of file vtkLight.h.

Definition at line 256 of file vtkLight.h.

Definition at line 257 of file vtkLight.h.

double vtkLight::TransformedPositionReturn[3] [protected]

Definition at line 258 of file vtkLight.h.

int vtkLight::LightType [protected]

Definition at line 259 of file vtkLight.h.


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

Generated on Mon Sep 27 18:32:27 2010 for VTK by  doxygen 1.5.6