Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages
vtkLight Class Reference
a virtual light for 3D rendering.
More...
#include <vtkLight.h>
Inheritance diagram for vtkLight:
[legend]Collaboration diagram for vtkLight:
[legend]List of all members.
Public Methods |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | Render (vtkRenderer *, int) |
| virtual void | SetColor (float, float, float) |
| virtual void | SetColor (float[3]) |
| virtual float * | GetColor () |
| virtual void | GetColor (float data[3]) |
| virtual void | SetPosition (float, float, float) |
| virtual void | SetPosition (float[3]) |
| virtual float * | GetPosition () |
| virtual void | GetPosition (float data[3]) |
| void | SetPosition (double *a) |
| virtual void | SetFocalPoint (float, float, float) |
| virtual void | SetFocalPoint (float[3]) |
| virtual float * | GetFocalPoint () |
| virtual void | GetFocalPoint (float data[3]) |
| void | SetFocalPoint (double *a) |
| virtual void | SetIntensity (float) |
| virtual float | 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 (float) |
| virtual float | GetExponent () |
| virtual void | SetConeAngle (float) |
| virtual float | GetConeAngle () |
| virtual void | SetAttenuationValues (float, float, float) |
| virtual void | SetAttenuationValues (float[3]) |
| virtual float * | GetAttenuationValues () |
| virtual void | GetAttenuationValues (float data[3]) |
| virtual void | SetTransformMatrix (vtkMatrix4x4 *) |
| virtual vtkMatrix4x4 * | GetTransformMatrix () |
| void | GetTransformedPosition (float &a0, float &a1, float &a2) |
| void | GetTransformedPosition (float a[3]) |
| float * | GetTransformedPosition () |
| void | GetTransformedFocalPoint (float &a0, float &a1, float &a2) |
| void | GetTransformedFocalPoint (float a[3]) |
| float * | GetTransformedFocalPoint () |
| void | SetDirectionAngle (float elevation, float azimuth) |
| void | SetDirectionAngle (float ang[2]) |
| void | DeepCopy (vtkLight *light) |
| virtual void | SetLightType (int) |
| virtual int | GetLightType () |
| void | SetLightTypeToHeadlight () |
| void | SetLightTypeToSceneLight () |
| void | SetLightTypeToCameraLight () |
| int | LightTypeIsHeadlight () |
| int | LightTypeIsSceneLight () |
| int | LightTypeIsCameraLight () |
| void | ReadSelf (istream &is) |
| void | WriteSelf (ostream &os) |
Static Public Methods |
| int | IsTypeOf (const char *type) |
| vtkLight * | SafeDownCast (vtkObject *o) |
| vtkLight * | New () |
Protected Methods |
| | vtkLight () |
| | ~vtkLight () |
| | vtkLight (const vtkLight &) |
| void | operator= (const vtkLight &) |
Protected Attributes |
| float | FocalPoint [3] |
| float | Position [3] |
| float | Intensity |
| float | Color [3] |
| int | Switch |
| int | Positional |
| float | Exponent |
| float | ConeAngle |
| float | AttenuationValues [3] |
| vtkMatrix4x4 * | TransformMatrix |
| float | TransformedFocalPointReturn [3] |
| float | TransformedPositionReturn [3] |
| int | LightType |
Detailed Description
a virtual light for 3D rendering.
-
Date:
-
2000/12/10 20:08:42
-
Revision:
-
1.46
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)
Definition at line 84 of file vtkLight.h.
Constructor & Destructor Documentation
| vtkLight::vtkLight |
( |
|
) |
[protected] |
|
| vtkLight::~vtkLight |
( |
|
) |
[protected] |
|
| vtkLight::vtkLight |
( |
const vtkLight & |
|
) |
[inline, protected] |
|
Member Function Documentation
| virtual const char* vtkLight::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkLight::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
| virtual int vtkLight::IsA |
( |
const char * |
type |
) |
[virtual] |
|
| vtkLight* vtkLight::SafeDownCast |
( |
vtkObject * |
o |
) |
[static] |
|
| 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. |
| 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, intensity=1, and the light is turned on.
Reimplemented from vtkObject.
Reimplemented in vtkRIBLight, vtkMesaLight, and vtkOpenGLLight. |
| virtual void vtkLight::Render |
( |
vtkRenderer * |
ren, |
|
|
int |
index |
|
) |
[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 99 of file vtkLight.h. |
| virtual void vtkLight::SetColor |
( |
float |
, |
|
|
float |
, |
|
|
float |
|
|
) |
[virtual] |
|
|
|
Set/Get the color of the light. |
| virtual void vtkLight::SetColor |
( |
float |
[3] |
) |
[virtual] |
|
| virtual float* vtkLight::GetColor |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::GetColor |
( |
float |
data[3] |
) |
[virtual] |
|
| virtual void vtkLight::SetPosition |
( |
float |
, |
|
|
float |
, |
|
|
float |
|
|
) |
[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 |
( |
float |
[3] |
) |
[virtual] |
|
| virtual float* vtkLight::GetPosition |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::GetPosition |
( |
float |
data[3] |
) |
[virtual] |
|
| void vtkLight::SetPosition |
( |
double * |
a |
) |
[inline] |
|
| virtual void vtkLight::SetFocalPoint |
( |
float |
, |
|
|
float |
, |
|
|
float |
|
|
) |
[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 |
( |
float |
[3] |
) |
[virtual] |
|
| virtual float* vtkLight::GetFocalPoint |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::GetFocalPoint |
( |
float |
data[3] |
) |
[virtual] |
|
| void vtkLight::SetFocalPoint |
( |
double * |
a |
) |
[inline] |
|
| virtual void vtkLight::SetIntensity |
( |
float |
|
) |
[virtual] |
|
|
|
Set/Get the brightness of the light (from one to zero). |
| virtual float vtkLight::GetIntensity |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::SetSwitch |
( |
int |
|
) |
[virtual] |
|
|
|
Turn the light on or off. |
| virtual int vtkLight::GetSwitch |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::SwitchOn |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::SwitchOff |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::SetPositional |
( |
int |
|
) |
[virtual] |
|
|
|
Turn positional lighting on or off. |
| virtual int vtkLight::GetPositional |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::PositionalOn |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::PositionalOff |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::SetExponent |
( |
float |
|
) |
[virtual] |
|
|
|
Set/Get the exponent of the cosine used in positional lighting. |
| virtual float vtkLight::GetExponent |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::SetConeAngle |
( |
float |
|
) |
[virtual] |
|
|
|
Set/Get the lighting cone angle of a positional light in degrees. A value of 180 indicates that you want no spot lighting effects just a positional light. |
| virtual float vtkLight::GetConeAngle |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::SetAttenuationValues |
( |
float |
, |
|
|
float |
, |
|
|
float |
|
|
) |
[virtual] |
|
|
|
Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order. |
| virtual void vtkLight::SetAttenuationValues |
( |
float |
[3] |
) |
[virtual] |
|
| virtual float* vtkLight::GetAttenuationValues |
( |
|
) |
[virtual] |
|
| virtual void vtkLight::GetAttenuationValues |
( |
float |
data[3] |
) |
[virtual] |
|
| 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] |
|
| void vtkLight::GetTransformedPosition |
( |
float & |
a0, |
|
|
float & |
a1, |
|
|
float & |
a2 |
|
) |
|
|
|
|
Get the position of the light, modified by the transformation matrix (if it exists). |
| void vtkLight::GetTransformedPosition |
( |
float |
a[3] |
) |
|
|
| float* vtkLight::GetTransformedPosition |
( |
|
) |
|
|
| void vtkLight::GetTransformedFocalPoint |
( |
float & |
a0, |
|
|
float & |
a1, |
|
|
float & |
a2 |
|
) |
|
|
|
|
Get the focal point of the light, modified by the transformation matrix (if it exists). |
| void vtkLight::GetTransformedFocalPoint |
( |
float |
a[3] |
) |
|
|
| float* vtkLight::GetTransformedFocalPoint |
( |
|
) |
|
|
| void vtkLight::SetDirectionAngle |
( |
float |
elevation, |
|
|
float |
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 |
( |
float |
ang[2] |
) |
[inline] |
|
| 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). |
| virtual int vtkLight::GetLightType |
( |
|
) |
[virtual] |
|
| void vtkLight::SetLightTypeToHeadlight |
( |
|
) |
|
|
| void vtkLight::SetLightTypeToSceneLight |
( |
|
) |
|
|
| void vtkLight::SetLightTypeToCameraLight |
( |
|
) |
|
|
| int vtkLight::LightTypeIsHeadlight |
( |
|
) |
|
|
|
|
Query the type of the light. |
| int vtkLight::LightTypeIsSceneLight |
( |
|
) |
|
|
| int vtkLight::LightTypeIsCameraLight |
( |
|
) |
|
|
| void vtkLight::ReadSelf |
( |
istream & |
is |
) |
|
|
| void vtkLight::WriteSelf |
( |
ostream & |
os |
) |
|
|
| void vtkLight::operator= |
( |
const vtkLight & |
|
) |
[inline, protected] |
|
Member Data Documentation
float vtkLight::FocalPoint[3] [protected]
|
|
float vtkLight::Position[3] [protected]
|
|
float vtkLight::Intensity [protected]
|
|
float vtkLight::Color[3] [protected]
|
|
int vtkLight::Switch [protected]
|
|
int vtkLight::Positional [protected]
|
|
float vtkLight::Exponent [protected]
|
|
float vtkLight::ConeAngle [protected]
|
|
float vtkLight::AttenuationValues[3] [protected]
|
|
float vtkLight::TransformedFocalPointReturn[3] [protected]
|
|
float vtkLight::TransformedPositionReturn[3] [protected]
|
|
int vtkLight::LightType [protected]
|
|
The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:52:43 2001 for VTK by
1.2.11.1 written by Dimitri van Heesch,
© 1997-2001