Main Page | Packages | Class Hierarchy | Class List | Directories | Class Members

IDVR.VolumeRenderer.RenderPrimitives.Light Class Reference

#include <Light.h>

List of all members.


Detailed Description

Class for the light data structure.

This class contains a couple of methods for the light object.

Author:
Christopher Thurnher
Version:
1.0
Date:
02-17-2005


Public Member Functions

 Light (void)
 This is the standard constructor.
 Light (int n_LightColor, Vector3 *n_DefaultLightDirection)
 This constructor initalized a light object with the given parameters.
 Light (Light *n_Light)
 This constructor initalized a light object with the given light object.
__property void set_LightColor (int n_LightColor)
 Sets the light color.
__property void set_DefaultLightDirection (Vector3 *n_DefaultLightDirection)
 Sets the default light direction.
__property void set_OffsetRotation (Matrix4 *n_OffsetRotation)
 Sets the offset light direction rotation matrix.
__property void set_BaseRotation (Matrix4 *n_BaseRotation)
 Sets the base light direction rotation matrix.
__property void set_LightViewMode (unsigned char n_LightViewMode)
 Sets the light view mode.
__property int get_LightColor (void)
 Returns the light color.
__property Vector3get_OffsetLightDirection (void)
 Returns the light direction.
__property Vector3get_BaseLightDirection (void)
 Returns the base light direction.
__property Vector3get_DefaultLightDirection (void)
 Returns the default light direction.
__property Matrix4get_OffsetRotation (void)
 Returns the offset light direction offset.
__property Matrix4get_BaseRotation (void)
 Returns the base light direction offset.
__property unsigned char get_LightViewMode (void)
 Returns the light view mode.
void modifyOffsetRotation (Matrix4 *n_OffsetRotation)
 Add the given rotation to the current rotation offset.
void modifyBaseRotation (Matrix4 *n_BaseRotation)
 Add the given rotation to the current rotation base.
void calculateLightDirection (void)
 Calculates new light direction.
float getNormalizedLightColorArray (void) __gc[]
 Returns the float array of the light color (values between 0 and 1).
Vector3getOpenGLLightDirection (void)
 Returns the light direction but with the y component reflected about x-axis.
void resetOffsetLightDirection (void)
 Resets the offset light direction to the base direction.
void resetBaseLightDirection (void)
 Resets the base light direction to the current offset direction.

Private Attributes

int m_LightColor
 The color of the light.
Vector3m_OffsetLightDirection
 The offset direction of the light.
Vector3m_BaseLightDirection
 The base direction of the light.
Vector3m_DefaultLightDirection
 The default direction of the light.
Matrix4m_OffsetRotation
 The offset rotaion of the light.
Matrix4m_BaseRotation
 The base rotaion of the light.
unsigned char m_LightViewMode
 The view mode of the light.


Constructor & Destructor Documentation

Light::Light void   ) 
 

This is the standard constructor.

Light::Light int  n_LightColor,
Vector3 n_DefaultLightDirection
 

This constructor initalized a light object with the given parameters.

Parameters:
n_LightColor the color of the light.
n_DefaultLightDirection the default direction of the light.

Light::Light Light n_Light  ) 
 

This constructor initalized a light object with the given light object.

Parameters:
n_Light the light object.


Member Function Documentation

void Light::calculateLightDirection void   ) 
 

Calculates new light direction.

Vector3 * Light::get_BaseLightDirection void   ) 
 

Returns the base light direction.

Returns:
The base direction of the light.

Matrix4 * Light::get_BaseRotation void   ) 
 

Returns the base light direction offset.

Returns:
The base rotation matrix of the light.

Vector3 * Light::get_DefaultLightDirection void   ) 
 

Returns the default light direction.

Returns:
The default direction of the light.

int Light::get_LightColor void   ) 
 

Returns the light color.

Returns:
The color of the light.

unsigned char Light::get_LightViewMode void   ) 
 

Returns the light view mode.

Returns:
The view mode of the light.

Vector3 * Light::get_OffsetLightDirection void   ) 
 

Returns the light direction.

Returns:
The offset direction of the light.

Matrix4 * Light::get_OffsetRotation void   ) 
 

Returns the offset light direction offset.

Returns:
The offset rotation matrix of the light.

float Light::getNormalizedLightColorArray void   ) 
 

Returns the float array of the light color (values between 0 and 1).

Returns:
The normalized color array of the light.

Vector3 * Light::getOpenGLLightDirection void   ) 
 

Returns the light direction but with the y component reflected about x-axis.

Returns:
The direction of the light with the y component reflected about x-axis.

void Light::modifyBaseRotation Matrix4 n_BaseRotation  ) 
 

Add the given rotation to the current rotation base.

Parameters:
n_BaseRotation The rotation matrix, with which the light's base rotation matrix is multiplied with.

void Light::modifyOffsetRotation Matrix4 n_OffsetRotation  ) 
 

Add the given rotation to the current rotation offset.

Parameters:
n_OffsetRotation The rotation matrix, with which the light's offset rotation matrix is multiplied with.

direction to the current offset direction void Light::resetBaseLightDirection void   ) 
 

Resets the base light direction to the current offset direction.

void Light::resetOffsetLightDirection void   ) 
 

Resets the offset light direction to the base direction.

void Light::set_BaseRotation Matrix4 n_BaseRotation  ) 
 

Sets the base light direction rotation matrix.

Parameters:
n_BaseRotation the base rotation matrix.

void Light::set_DefaultLightDirection Vector3 n_DefaultLightDirection  ) 
 

Sets the default light direction.

Parameters:
n_DefaultLightDirection the default light direction.

void Light::set_LightColor int  n_LightColor  ) 
 

Sets the light color.

Parameters:
n_LightColor the color of the light.

void Light::set_LightViewMode unsigned char  n_LightViewMode  ) 
 

Sets the light view mode.

Parameters:
n_LightViewMode the light view mode.

void Light::set_OffsetRotation Matrix4 n_OffsetRotation  ) 
 

Sets the offset light direction rotation matrix.

Parameters:
n_OffsetRotation the offset rotation matrix.


The documentation for this class was generated from the following files:
Generated on Sat Apr 9 11:51:01 2005 for RayCaster wiht Importance Driven Volume Rendering (IDVR) by  doxygen 1.4.1