ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkLight Class Reference

vtkLight - a virtual light for 3D rendering More...

Inheritance diagram for Kitware.VTK.vtkLight:
[legend]
Collaboration diagram for Kitware.VTK.vtkLight:
[legend]

List of all members.

Public Member Functions

 vtkLight (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkLight ()
 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.
void DeepCopy (vtkLight light)
 Perform deep copy of this light.
virtual double[] GetAmbientColor ()
 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 GetAmbientColor (IntPtr data)
 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[] GetAttenuationValues ()
 Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.
virtual void GetAttenuationValues (IntPtr data)
 Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.
virtual double GetConeAngle ()
 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[] GetDiffuseColor ()
 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 GetDiffuseColor (IntPtr data)
 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 GetExponent ()
 Set/Get the exponent of the cosine used in positional lighting.
virtual double GetExponentMaxValue ()
 Set/Get the exponent of the cosine used in positional lighting.
virtual double GetExponentMinValue ()
 Set/Get the exponent of the cosine used in positional lighting.
virtual double[] GetFocalPoint ()
 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 GetFocalPoint (IntPtr data)
 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 GetIntensity ()
 Set/Get the brightness of the light (from one to zero).
virtual int GetLightType ()
 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.
virtual double[] GetPosition ()
 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 GetPosition (IntPtr data)
 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 int GetPositional ()
 Turn positional lighting on or off.
virtual double[] GetSpecularColor ()
 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 GetSpecularColor (IntPtr data)
 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 int GetSwitch ()
 Turn the light on or off.
virtual vtkMatrix4x4 GetTransformMatrix ()
 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 GetTransformedFocalPoint (ref double a0, ref double a1, ref double a2)
 Get the focal point of the light, modified by the transformation matrix (if it exists).
void GetTransformedFocalPoint (IntPtr a)
 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 GetTransformedPosition (ref double a0, ref double a1, ref double a2)
 Get the position of the light, modified by the transformation matrix (if it exists).
void GetTransformedPosition (IntPtr a)
 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).
override int IsA (string type)
 Undocumented Block.
int LightTypeIsCameraLight ()
 Query the type of the light.
int LightTypeIsHeadlight ()
 Query the type of the light.
int LightTypeIsSceneLight ()
 Query the type of the light.
new vtkLight NewInstance ()
 Undocumented Block.
virtual void PositionalOff ()
 Turn positional lighting on or off.
virtual void PositionalOn ()
 Turn positional lighting on or off.
virtual void Render (vtkRenderer arg0, int arg1)
 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.
virtual void SetAmbientColor (double _arg1, double _arg2, double _arg3)
 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 SetAmbientColor (IntPtr _arg)
 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 SetAttenuationValues (double _arg1, double _arg2, double _arg3)
 Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.
virtual void SetAttenuationValues (IntPtr _arg)
 Set/Get the quadratic attenuation constants. They are specified as constant, linear, and quadratic, in that order.
void SetColor (double arg0, double arg1, double arg2)
 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 SetColor (IntPtr a)
 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 SetConeAngle (double _arg)
 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 SetDiffuseColor (double _arg1, double _arg2, double _arg3)
 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 SetDiffuseColor (IntPtr _arg)
 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 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 SetDirectionAngle (IntPtr ang)
 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.
virtual void SetExponent (double _arg)
 Set/Get the exponent of the cosine used in positional lighting.
virtual void SetFocalPoint (double _arg1, double _arg2, double _arg3)
 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 SetFocalPoint (IntPtr _arg)
 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 SetIntensity (double _arg)
 Set/Get the brightness of the light (from one to zero).
virtual void SetLightType (int _arg)
 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.
void SetLightTypeToCameraLight ()
 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.
void SetLightTypeToHeadlight ()
 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.
void SetLightTypeToSceneLight ()
 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.
virtual void SetPosition (double _arg1, double _arg2, double _arg3)
 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 SetPosition (IntPtr _arg)
 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 SetPositional (int _arg)
 Turn positional lighting on or off.
virtual void SetSpecularColor (double _arg1, double _arg2, double _arg3)
 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 SetSpecularColor (IntPtr _arg)
 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 SetSwitch (int _arg)
 Turn the light on or off.
virtual void SetTransformMatrix (vtkMatrix4x4 arg0)
 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 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). This is a shallow clone (TransformMatrix is referenced)
virtual void SwitchOff ()
 Turn the light on or off.
virtual void SwitchOn ()
 Turn the light on or off.

Static Public Member Functions

static new vtkLight New ()
 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.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkLight SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkLight"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "8vtkLight"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkLight_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLight_DeepCopy_01 (HandleRef pThis, HandleRef light)
static internal IntPtr vtkLight_GetAmbientColor_02 (HandleRef pThis)
static internal void vtkLight_GetAmbientColor_03 (HandleRef pThis, IntPtr data)
static internal IntPtr vtkLight_GetAttenuationValues_04 (HandleRef pThis)
static internal void vtkLight_GetAttenuationValues_05 (HandleRef pThis, IntPtr data)
static internal double vtkLight_GetConeAngle_06 (HandleRef pThis)
static internal IntPtr vtkLight_GetDiffuseColor_07 (HandleRef pThis)
static internal void vtkLight_GetDiffuseColor_08 (HandleRef pThis, IntPtr data)
static internal double vtkLight_GetExponent_09 (HandleRef pThis)
static internal double vtkLight_GetExponentMaxValue_10 (HandleRef pThis)
static internal double vtkLight_GetExponentMinValue_11 (HandleRef pThis)
static internal IntPtr vtkLight_GetFocalPoint_12 (HandleRef pThis)
static internal void vtkLight_GetFocalPoint_13 (HandleRef pThis, IntPtr data)
static internal double vtkLight_GetIntensity_14 (HandleRef pThis)
static internal int vtkLight_GetLightType_15 (HandleRef pThis)
static internal IntPtr vtkLight_GetPosition_16 (HandleRef pThis)
static internal void vtkLight_GetPosition_17 (HandleRef pThis, IntPtr data)
static internal int vtkLight_GetPositional_18 (HandleRef pThis)
static internal IntPtr vtkLight_GetSpecularColor_19 (HandleRef pThis)
static internal void vtkLight_GetSpecularColor_20 (HandleRef pThis, IntPtr data)
static internal int vtkLight_GetSwitch_21 (HandleRef pThis)
static internal IntPtr vtkLight_GetTransformMatrix_22 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLight_GetTransformedFocalPoint_23 (HandleRef pThis, ref double a0, ref double a1, ref double a2)
static internal void vtkLight_GetTransformedFocalPoint_24 (HandleRef pThis, IntPtr a)
static internal IntPtr vtkLight_GetTransformedFocalPoint_25 (HandleRef pThis)
static internal void vtkLight_GetTransformedPosition_26 (HandleRef pThis, ref double a0, ref double a1, ref double a2)
static internal void vtkLight_GetTransformedPosition_27 (HandleRef pThis, IntPtr a)
static internal IntPtr vtkLight_GetTransformedPosition_28 (HandleRef pThis)
static internal int vtkLight_IsA_29 (HandleRef pThis, string type)
static internal int vtkLight_IsTypeOf_30 (string type)
static internal int vtkLight_LightTypeIsCameraLight_31 (HandleRef pThis)
static internal int vtkLight_LightTypeIsHeadlight_32 (HandleRef pThis)
static internal int vtkLight_LightTypeIsSceneLight_33 (HandleRef pThis)
static internal IntPtr vtkLight_NewInstance_35 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLight_PositionalOff_36 (HandleRef pThis)
static internal void vtkLight_PositionalOn_37 (HandleRef pThis)
static internal void vtkLight_Render_38 (HandleRef pThis, HandleRef arg0, int arg1)
static internal IntPtr vtkLight_SafeDownCast_39 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLight_SetAmbientColor_40 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkLight_SetAmbientColor_41 (HandleRef pThis, IntPtr _arg)
static internal void vtkLight_SetAttenuationValues_42 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkLight_SetAttenuationValues_43 (HandleRef pThis, IntPtr _arg)
static internal void vtkLight_SetColor_44 (HandleRef pThis, double arg0, double arg1, double arg2)
static internal void vtkLight_SetColor_45 (HandleRef pThis, IntPtr a)
static internal void vtkLight_SetConeAngle_46 (HandleRef pThis, double _arg)
static internal void vtkLight_SetDiffuseColor_47 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkLight_SetDiffuseColor_48 (HandleRef pThis, IntPtr _arg)
static internal void vtkLight_SetDirectionAngle_49 (HandleRef pThis, double elevation, double azimuth)
static internal void vtkLight_SetDirectionAngle_50 (HandleRef pThis, IntPtr ang)
static internal void vtkLight_SetExponent_51 (HandleRef pThis, double _arg)
static internal void vtkLight_SetFocalPoint_52 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkLight_SetFocalPoint_53 (HandleRef pThis, IntPtr _arg)
static internal void vtkLight_SetIntensity_54 (HandleRef pThis, double _arg)
static internal void vtkLight_SetLightType_55 (HandleRef pThis, int _arg)
static internal void vtkLight_SetLightTypeToCameraLight_56 (HandleRef pThis)
static internal void vtkLight_SetLightTypeToHeadlight_57 (HandleRef pThis)
static internal void vtkLight_SetLightTypeToSceneLight_58 (HandleRef pThis)
static internal void vtkLight_SetPosition_59 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkLight_SetPosition_60 (HandleRef pThis, IntPtr _arg)
static internal void vtkLight_SetPositional_61 (HandleRef pThis, int _arg)
static internal void vtkLight_SetSpecularColor_62 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkLight_SetSpecularColor_63 (HandleRef pThis, IntPtr _arg)
static internal void vtkLight_SetSwitch_64 (HandleRef pThis, int _arg)
static internal void vtkLight_SetTransformMatrix_65 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkLight_ShallowClone_66 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkLight_SwitchOff_67 (HandleRef pThis)
static internal void vtkLight_SwitchOn_68 (HandleRef pThis)

Static Private Member Functions

static vtkLight ()
 Automatically generated type registration mechanics.

Detailed Description

vtkLight - a virtual light for 3D rendering

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


Constructor & Destructor Documentation

static Kitware.VTK.vtkLight.vtkLight ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkLight.vtkLight ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

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.


Member Function Documentation

Perform deep copy of this light.

override void Kitware.VTK.vtkLight.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

virtual double [] Kitware.VTK.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 Kitware.VTK.vtkLight.GetAmbientColor ( IntPtr  data) [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 [] Kitware.VTK.vtkLight.GetAttenuationValues ( ) [virtual]

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

virtual void Kitware.VTK.vtkLight.GetAttenuationValues ( IntPtr  data) [virtual]

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

virtual double Kitware.VTK.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 double [] Kitware.VTK.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 Kitware.VTK.vtkLight.GetDiffuseColor ( IntPtr  data) [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 Kitware.VTK.vtkLight.GetExponent ( ) [virtual]

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

virtual double Kitware.VTK.vtkLight.GetExponentMaxValue ( ) [virtual]

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

virtual double Kitware.VTK.vtkLight.GetExponentMinValue ( ) [virtual]

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

virtual double [] Kitware.VTK.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 Kitware.VTK.vtkLight.GetFocalPoint ( IntPtr  data) [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 Kitware.VTK.vtkLight.GetIntensity ( ) [virtual]

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

virtual int Kitware.VTK.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.

virtual double [] Kitware.VTK.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 Kitware.VTK.vtkLight.GetPosition ( IntPtr  data) [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 int Kitware.VTK.vtkLight.GetPositional ( ) [virtual]

Turn positional lighting on or off.

virtual double [] Kitware.VTK.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 Kitware.VTK.vtkLight.GetSpecularColor ( IntPtr  data) [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 int Kitware.VTK.vtkLight.GetSwitch ( ) [virtual]

Turn the light on or off.

void Kitware.VTK.vtkLight.GetTransformedFocalPoint ( ref double  a0,
ref double  a1,
ref double  a2 
)

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

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

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

void Kitware.VTK.vtkLight.GetTransformedPosition ( ref double  a0,
ref double  a1,
ref double  a2 
)

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

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

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

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.

Here is the call graph for this function:

override int Kitware.VTK.vtkLight.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

static new int Kitware.VTK.vtkLight.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

Query the type of the light.

Query the type of the light.

Query the type of the light.

static new vtkLight Kitware.VTK.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 Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

virtual void Kitware.VTK.vtkLight.PositionalOff ( ) [virtual]

Turn positional lighting on or off.

virtual void Kitware.VTK.vtkLight.PositionalOn ( ) [virtual]

Turn positional lighting on or off.

virtual void Kitware.VTK.vtkLight.Render ( vtkRenderer  arg0,
int  arg1 
) [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 Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkLight.SetAmbientColor ( double  _arg1,
double  _arg2,
double  _arg3 
) [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 Kitware.VTK.vtkLight.SetAmbientColor ( IntPtr  _arg) [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 Kitware.VTK.vtkLight.SetAttenuationValues ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

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

virtual void Kitware.VTK.vtkLight.SetAttenuationValues ( IntPtr  _arg) [virtual]

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

void Kitware.VTK.vtkLight.SetColor ( double  arg0,
double  arg1,
double  arg2 
)

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 Kitware.VTK.vtkLight.SetColor ( IntPtr  a)

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 Kitware.VTK.vtkLight.SetConeAngle ( double  _arg) [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 Kitware.VTK.vtkLight.SetDiffuseColor ( double  _arg1,
double  _arg2,
double  _arg3 
) [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 Kitware.VTK.vtkLight.SetDiffuseColor ( IntPtr  _arg) [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 Kitware.VTK.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.

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.

virtual void Kitware.VTK.vtkLight.SetExponent ( double  _arg) [virtual]

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

virtual void Kitware.VTK.vtkLight.SetFocalPoint ( double  _arg1,
double  _arg2,
double  _arg3 
) [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 Kitware.VTK.vtkLight.SetFocalPoint ( IntPtr  _arg) [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 Kitware.VTK.vtkLight.SetIntensity ( double  _arg) [virtual]

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

virtual void Kitware.VTK.vtkLight.SetLightType ( int  _arg) [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.

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.

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.

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 void Kitware.VTK.vtkLight.SetPosition ( double  _arg1,
double  _arg2,
double  _arg3 
) [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 Kitware.VTK.vtkLight.SetPosition ( IntPtr  _arg) [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 Kitware.VTK.vtkLight.SetPositional ( int  _arg) [virtual]

Turn positional lighting on or off.

virtual void Kitware.VTK.vtkLight.SetSpecularColor ( double  _arg1,
double  _arg2,
double  _arg3 
) [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 Kitware.VTK.vtkLight.SetSpecularColor ( IntPtr  _arg) [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 Kitware.VTK.vtkLight.SetSwitch ( int  _arg) [virtual]

Turn the light on or off.

virtual void Kitware.VTK.vtkLight.SetTransformMatrix ( vtkMatrix4x4  arg0) [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.

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)

Here is the call graph for this function:

virtual void Kitware.VTK.vtkLight.SwitchOff ( ) [virtual]

Turn the light on or off.

virtual void Kitware.VTK.vtkLight.SwitchOn ( ) [virtual]

Turn the light on or off.

static internal void Kitware.VTK.vtkLight.vtkLight_DeepCopy_01 ( HandleRef  pThis,
HandleRef  light 
) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetAmbientColor_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetAmbientColor_03 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetAttenuationValues_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetAttenuationValues_05 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal double Kitware.VTK.vtkLight.vtkLight_GetConeAngle_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetDiffuseColor_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetDiffuseColor_08 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal double Kitware.VTK.vtkLight.vtkLight_GetExponent_09 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLight.vtkLight_GetExponentMaxValue_10 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkLight.vtkLight_GetExponentMinValue_11 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetFocalPoint_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetFocalPoint_13 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal double Kitware.VTK.vtkLight.vtkLight_GetIntensity_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_GetLightType_15 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetPosition_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetPosition_17 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_GetPositional_18 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetSpecularColor_19 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetSpecularColor_20 ( HandleRef  pThis,
IntPtr  data 
) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_GetSwitch_21 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetTransformedFocalPoint_23 ( HandleRef  pThis,
ref double  a0,
ref double  a1,
ref double  a2 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetTransformedFocalPoint_24 ( HandleRef  pThis,
IntPtr  a 
) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetTransformedFocalPoint_25 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetTransformedPosition_26 ( HandleRef  pThis,
ref double  a0,
ref double  a1,
ref double  a2 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_GetTransformedPosition_27 ( HandleRef  pThis,
IntPtr  a 
) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetTransformedPosition_28 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_GetTransformMatrix_22 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_IsA_29 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_IsTypeOf_30 ( string  type) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_LightTypeIsCameraLight_31 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_LightTypeIsHeadlight_32 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkLight.vtkLight_LightTypeIsSceneLight_33 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_NewInstance_35 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_PositionalOff_36 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_PositionalOn_37 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_Render_38 ( HandleRef  pThis,
HandleRef  arg0,
int  arg1 
) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_SafeDownCast_39 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetAmbientColor_40 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetAmbientColor_41 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetAttenuationValues_42 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetAttenuationValues_43 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetColor_44 ( HandleRef  pThis,
double  arg0,
double  arg1,
double  arg2 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetColor_45 ( HandleRef  pThis,
IntPtr  a 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetConeAngle_46 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetDiffuseColor_47 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetDiffuseColor_48 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetDirectionAngle_49 ( HandleRef  pThis,
double  elevation,
double  azimuth 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetDirectionAngle_50 ( HandleRef  pThis,
IntPtr  ang 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetExponent_51 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetFocalPoint_52 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetFocalPoint_53 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetIntensity_54 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetLightType_55 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetLightTypeToCameraLight_56 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetLightTypeToHeadlight_57 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetLightTypeToSceneLight_58 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetPosition_59 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetPosition_60 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetPositional_61 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetSpecularColor_62 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetSpecularColor_63 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetSwitch_64 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SetTransformMatrix_65 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkLight.vtkLight_ShallowClone_66 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SwitchOff_67 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkLight.vtkLight_SwitchOn_68 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkLight.MRClassNameKey = "8vtkLight" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.

new const string Kitware.VTK.vtkLight.MRFullTypeName = "Kitware.VTK.vtkLight"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkRIBLight, and Kitware.VTK.vtkOpenGLLight.


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