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

IDVR.VolumeRenderer.RenderPrimitives.RaySample Class Reference

#include <RaySample.h>

List of all members.


Detailed Description

Class for the raysample data structure.

This class contains a couple of methods for the raysample primitive. Each raysample has various properties, such as color, opacity, density, gradient vector, objectID and coordinates, which wil be described later.

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


Public Member Functions

 RaySample (void)
 This is the standard constructor.
 RaySample (Vector3 *n_Coords)
 This constructor initalized a raysample with the given coordinates.
 RaySample (float n_Color __gc[], float n_Opacity, unsigned short n_ObjectID)
 This constructor initalized a raysample with the given parameters.
 ~RaySample (void)
 This is the standard destructor.
__property void set_Color (float n_Color __gc[])
 Sets the color of the raysample.
__property void set_Density (unsigned short n_Density)
 Sets the density of the raysample.
__property void set_Opacity (float n_Opacity)
 Sets the opacity of the raysample.
__property void set_Gradient (RenderPrimitives::Gradient *n_Gradient)
 Sets the gradient of the raysample.
__property void set_ObjectID (unsigned short n_ObjectID)
 Sets the objectID of the raysample.
__property void set_Coords (Vector3 *n_Coords)
 Sets the coordinates of the raysample.
__property float get_Color (void) __gc[]
 Returns the color of the raysample.
__property unsigned short get_Density (void)
 Returns the density of the raysample.
__property float get_Opacity (void)
 Returns the opacity of the raysample.
__property RenderPrimitives::Gradientget_Gradient (void)
 Returns the gradient of the raysample.
__property unsigned short get_ObjectID (void)
 Returns the objectID of the raysample.
__property Vector3get_Coords (void)
 Returns the coordinates of the raysample.

Private Attributes

float m_Color __gc []
 The color of the raysample.
unsigned short m_Density
 The density of the raysample.
float m_Opacity
 The opacity of the raysample.
RenderPrimitives::Gradientm_Gradient
 The gradient of the raysample.
unsigned short m_ObjectID
 The objectID of the raysample.
Vector3m_Coords
 The coordinates of the raysample.


Constructor & Destructor Documentation

RaySample::RaySample void   ) 
 

This is the standard constructor.

This standard constructor initialzed all elements with zero.

RaySample::RaySample Vector3 n_Coords  ) 
 

This constructor initalized a raysample with the given coordinates.

All other parmeters are set to zero.

Parameters:
n_Coords the coordinates of the raysample.

RaySample::RaySample float n_Color  __gc[],
float  n_Opacity,
unsigned short  n_ObjectID
 

This constructor initalized a raysample with the given parameters.

Parameters:
n_Color the color of the raysample.
n_Opacity the opacity of the raysample.
n_ObjectID the objectID of the raysample.

RaySample::~RaySample void   ) 
 

This is the standard destructor.


Member Function Documentation

float RaySample::get_Color void   ) 
 

Returns the color of the raysample.

Returns:
The color of the raysample.

Vector3 * RaySample::get_Coords void   ) 
 

Returns the coordinates of the raysample.

Returns:
The coordinates of the raysample.

unsigned short RaySample::get_Density void   ) 
 

Returns the density of the raysample.

Returns:
The density of the raysample.

Gradient * RaySample::get_Gradient void   ) 
 

Returns the gradient of the raysample.

Returns:
The gradient of the raysample.

unsigned short RaySample::get_ObjectID void   ) 
 

Returns the objectID of the raysample.

Returns:
The objectID of the raysample.

float RaySample::get_Opacity void   ) 
 

Returns the opacity of the raysample.

Returns:
The opacity of the raysample.

void RaySample::set_Color float n_Color  __gc[]  ) 
 

Sets the color of the raysample.

Parameters:
n_Color the color of the raysample.

void RaySample::set_Coords Vector3 n_Coords  ) 
 

Sets the coordinates of the raysample.

Parameters:
n_Coords the coordinates of the raysample.

void RaySample::set_Density unsigned short  n_Density  ) 
 

Sets the density of the raysample.

Parameters:
n_Density the density of the raysample.

void RaySample::set_Gradient RenderPrimitives::Gradient n_Gradient  ) 
 

Sets the gradient of the raysample.

Parameters:
n_Gradient the gradient of the raysample.

void RaySample::set_ObjectID unsigned short  n_ObjectID  ) 
 

Sets the objectID of the raysample.

Parameters:
n_ObjectID the objectID of the raysample.

void RaySample::set_Opacity float  n_Opacity  ) 
 

Sets the opacity of the raysample.

Parameters:
n_Opacity the opacity of the raysample.


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