mitkSurfaceProperty Class Reference

mitkSurfaceProperty - properties of an mitkSurfaceModel More...

#include <mitkSurfaceProperty.h>

Inherits mitkObject.

Inheritance diagram for mitkSurfaceProperty:

[legend]Collaboration diagram for mitkSurfaceProperty:

[legend]List of all members.

Public Member Functions
virtual void	PrintSelf (ostream &os)
	mitkSurfaceProperty ()
bool	IsModified () const
void	SetUnmodified ()
void	SetInterpolationType (int intpType)
int	GetInterpolationType () const
void	SetInterpolationTypeToFlat ()
void	SetInterpolationTypeToGouraud ()
void	SetInterpolationTypeToPhong ()
const char *	GetInterpolationTypeAsString () const
void	SetRepresentationType (int repType)
int	GetRepresentationType () const
void	SetRepresentationTypeToPoints ()
void	SetRepresentationTypeToWireframe ()
void	SetRepresentationTypeToSurface ()
const char *	GetRepresentationTypeAsString () const
void	SetAmbient (float value)
float	GetAmbient () const
void	SetDiffuse (float value)
float	GetDiffuse () const
void	SetSpecular (float value)
float	GetSpecular () const
void	SetSpecularPower (float value)
float	GetSpecularPower () const
void	SetOpacity (float value)
float	GetOpacity () const
void	SetLineWidth (float value)
float	GetLineWidth () const
void	SetPointSize (float value)
float	GetPointSize () const
void	SetLineStipplePattern (unsigned short value)
unsigned short	GetLineStipplePattern () const
void	SetLineStippleRepeatFactor (int value)
int	GetLineStippleRepeatFactor () const
void	SetColor (float red, float green, float blue, float alpha=1.0f)
void	SetColor (float color[4])
float *	GetColor ()
void	GetColor (float color[4])
	mitkSetColorMacro (AmbientColor, float)
	mitkGetColorMacro (AmbientColor, float)
	mitkSetColorMacro (DiffuseColor, float)
	mitkGetColorMacro (DiffuseColor, float)
	mitkSetColorMacro (SpecularColor, float)
	mitkGetColorMacro (SpecularColor, float)
	mitkSetColorMacro (EmissionColor, float)
	mitkGetColorMacro (EmissionColor, float)
	mitkSetColorMacro (EdgeColor, float)
	mitkGetColorMacro (EdgeColor, float)

---

Detailed Description

mitkSurfaceProperty - properties of an mitkSurfaceModel

mitkSurfaceProperty is a class contains properties of an mitkSurfaceModel including geometry representation parameters and material parameters.

---

Constructor & Destructor Documentation

mitkSurfaceProperty::mitkSurfaceProperty (   )

Default constructor.

---

Member Function Documentation

float mitkSurfaceProperty::GetAmbient (   )  const [inline]

Get the ambient coefficient. Returns: Return the ambient coefficient.

void mitkSurfaceProperty::GetColor (  float  color[4]  )

Get the color of the surface decided by the value and coefficient of ambient, diffuse, specular and emission color(material) of the surface. Returns: color[4] return a float array contains red, green, blue and alpha value in turn.

float* mitkSurfaceProperty::GetColor (   )

Get the color of the surface decided by the value and coefficient of ambient, diffuse, specular and emission color(material) of the surface. Returns: Return a float array contains red, green, blue and alpha value in turn.

float mitkSurfaceProperty::GetDiffuse (   )  const [inline]

Get the diffuse coefficient. Returns: Return the diffuse coefficient.

int mitkSurfaceProperty::GetInterpolationType (   )  const [inline]

Get the interpolation type for sampling a surface. Returns: Return interpolation type for sampling a surface, the value could be one of the follows: MITK_SURFACE_FLAT (flat interpolation type) MITK_SURFACE_GOURAUD (smooth interpolation type) MITK_SURFACE_PHONG (smooth interpolation type).

const char * mitkSurfaceProperty::GetInterpolationTypeAsString (   )  const [inline]

Get the interpolation type for sampling a surface as a string. Returns: Return the string of interpolation type.

unsigned short mitkSurfaceProperty::GetLineStipplePattern (   )  const [inline]

Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). This is only implemented for OpenGL. The default is 0xFFFF. Returns: Return a 16-bit binary pattern represent the stippling pattern of a Line (1 = pixel on, 0 = pixel off).

int mitkSurfaceProperty::GetLineStippleRepeatFactor (   )  const [inline]

Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. Returns: Return the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated

float mitkSurfaceProperty::GetLineWidth (   )  const [inline]

Get the line width. The width is expressed in screen units. Returns: Return the line width.

float mitkSurfaceProperty::GetOpacity (   )  const [inline]

Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent. Returns: Return the object's opacity.

float mitkSurfaceProperty::GetPointSize (   )  const [inline]

Get the point size. The size is expressed in screen units. Returns: Return the point size.

int mitkSurfaceProperty::GetRepresentationType (   )  const [inline]

Get the geometry representation of the surface. Returns: Return geometry representation of a surface, the value should be one of the follows: MITK_MESH_POINTS (points representation) MITK_MESH_WIREFRAME (wireframe representation) MITK_MESH_SURFACE (surface representation).

const char * mitkSurfaceProperty::GetRepresentationTypeAsString (   )  const [inline]

Get the geometry representation of the surface as a string. Returns: Return the string of geometry representation.

float mitkSurfaceProperty::GetSpecular (   )  const [inline]

Get the specular coefficient. Returns: Return the specular coefficient.

float mitkSurfaceProperty::GetSpecularPower (   )  const [inline]

Get the specular power. Returns: Return the specular power (between 0.0 and 128.0).

bool mitkSurfaceProperty::IsModified (   )  const [inline]

Test if some of the properties are modified. Returns: Return true if some of the properties are modified. Otherwise return false.

mitkSurfaceProperty::mitkGetColorMacro (  EdgeColor  , float  )

A group of functions to get the color of edges. This macro will generate three functions: float* GetEdgeColor(); void GetEdgeColor(float &red, float &green, float &blue, float &alpha = 1.0f); void GetEdgeColor(float color[4]);

mitkSurfaceProperty::mitkGetColorMacro (  EmissionColor  , float  )

A group of functions to get the emission color of the surface. This macro will generate three functions: float* GetEmissionColor(); void GetEmissionColor(float &red, float &green, float &blue, float &alpha = 1.0f); void GetEmissionColor(float color[4]);

mitkSurfaceProperty::mitkGetColorMacro (  SpecularColor  , float  )

A group of functions to get the specular color of the surface. This macro will generate three functions: float* GetSpecularColor(); void GetSpecularColor(float &red, float &green, float &blue, float &alpha = 1.0f); void GetSpecularColor(float color[4]);

mitkSurfaceProperty::mitkGetColorMacro (  DiffuseColor  , float  )

A group of functions to get the diffuse color of the surface. This macro will generate three functions: float* GetDiffuseColor(); void GetDiffuseColor(float &red, float &green, float &blue, float &alpha = 1.0f); void GetDiffuseColor(float color[4]);

mitkSurfaceProperty::mitkGetColorMacro (  AmbientColor  , float  )

A group of functions to get the ambient color of the surface. This macro will generate three functions: float* GetAmbientColor(); void GetAmbientColor(float &red, float &green, float &blue, float &alpha = 1.0f); void GetAmbientColor(float color[4]);

mitkSurfaceProperty::mitkSetColorMacro (  EdgeColor  , float  )

A group of functions to set color of edges. This macro will generate two functions: void SetEdgeColor(float red, float green, float blue, float alpha = 1.0f); void SetEdgeColor(float color[4]);

mitkSurfaceProperty::mitkSetColorMacro (  EmissionColor  , float  )

A group of functions to set the emission color of the surface. This macro will generate two functions: void SetEmissionColor(float red, float green, float blue, float alpha = 1.0f); void SetEmissionColor(float color[4]);

mitkSurfaceProperty::mitkSetColorMacro (  SpecularColor  , float  )

A group of functions to set the specular color of the surface. This macro will generate two functions: void SetSpecularColor(float red, float green, float blue, float alpha = 1.0f); void SetSpecularColor(float color[4]);

mitkSurfaceProperty::mitkSetColorMacro (  DiffuseColor  , float  )

A group of functions to set the diffuse color of the surface. This macro will generate two functions: void SetDiffuseColor(float red, float green, float blue, float alpha = 1.0f); void SetDiffuseColor(float color[4]);

mitkSurfaceProperty::mitkSetColorMacro (  AmbientColor  , float  )

A group of functions to set the ambient color of the surface. This macro will generate two functions: void SetAmbientColor(float red, float green, float blue, float alpha = 1.0f); void SetAmbientColor(float color[4]);

virtual void mitkSurfaceProperty::PrintSelf (  ostream &  os  )  [virtual]

Print the necessary information about this object for the debugging purpose. Parameters: os  The specified ostream to output information. Reimplemented from mitkObject.

void mitkSurfaceProperty::SetAmbient (  float  value  )  [inline]

Set the ambient coefficient. Parameters: value  the value of ambient coefficient

void mitkSurfaceProperty::SetColor (  float  color[4]  )  [inline]

Set the color of the surface. Has the side effect of setting the ambient, diffuse and specular colors as well. This is basically a quick overall color setting method. Parameters: color[0]  the red value of the color color[1]  the green value of the color color[2]  the blue value of the color color[3]  the alpha value of the color (default is 1.0)

void mitkSurfaceProperty::SetColor (  float  red, float  green, float  blue, float  alpha = 1.0f )

Set the color of the surface. Has the side effect of setting the ambient, diffuse and specular colors as well. This is basically a quick overall color setting method. Parameters: red  the red value of the color green  the green value of the color blue  the blue value of the color alpha  the alpha value of the color (default is 1.0)

void mitkSurfaceProperty::SetDiffuse (  float  value  )  [inline]

Set the diffuse coefficient. Parameters: value  the diffuse coefficient

void mitkSurfaceProperty::SetInterpolationType (  int  intpType  )  [inline]

Set the interpolation type for sampling a surface. Parameters: intpType  interpolation type for sampling a surface, the value should be one of the follows: MITK_SURFACE_FLAT (flat interpolation type) MITK_SURFACE_GOURAUD (smooth interpolation type) MITK_SURFACE_PHONG (smooth interpolation type)

void mitkSurfaceProperty::SetInterpolationTypeToFlat (   )  [inline]

Set the interpolation type for sampling a surface to MITK_SURFACE_FLAT.

void mitkSurfaceProperty::SetInterpolationTypeToGouraud (   )  [inline]

Set the interpolation type for sampling a surface to MITK_SURFACE_GOURAUD.

void mitkSurfaceProperty::SetInterpolationTypeToPhong (   )  [inline]

Set the interpolation type for sampling a surface to MITK_SURFACE_PHONG.

void mitkSurfaceProperty::SetLineStipplePattern (  unsigned short  value  )  [inline]

Set the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). This is only implemented for OpenGL. The default is 0xFFFF. Parameters: value  a 16-bit binary pattern represent the stippling pattern of a Line (1 = pixel on, 0 = pixel off).

void mitkSurfaceProperty::SetLineStippleRepeatFactor (  int  value  )  [inline]

Set the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. This is only implemented for OpenGL. The default is 1. Parameters: value  the stippling repeat factor of a Line pecifies how many times each bit in the pattern is to be repeated

void mitkSurfaceProperty::SetLineWidth (  float  value  )  [inline]

Set the line width. The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. Parameters: value  the line width (default value is 1.0)

void mitkSurfaceProperty::SetOpacity (  float  value  )  [inline]

Set the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent. Parameters: value  the object's opacity

void mitkSurfaceProperty::SetPointSize (  float  value  )  [inline]

Set the point size. The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0. Parameters: value  the point size (default value is 1.0)

void mitkSurfaceProperty::SetRepresentationType (  int  repType  )  [inline]

Set the geometry representation of the surface. Parameters: repType  geometry representation of a surface, the value should be one of the follows: MITK_MESH_POINTS (points representation) MITK_MESH_WIREFRAME (wireframe representation) MITK_MESH_SURFACE (surface representation)

void mitkSurfaceProperty::SetRepresentationTypeToPoints (   )  [inline]

Set the geometry representation of the surface to MITK_MESH_POINTS.

void mitkSurfaceProperty::SetRepresentationTypeToSurface (   )  [inline]

Set the geometry representation of the surface to MITK_MESH_SURFACE.

void mitkSurfaceProperty::SetRepresentationTypeToWireframe (   )  [inline]

Set the geometry representation of the surface to MITK_MESH_WIREFRAME.

void mitkSurfaceProperty::SetSpecular (  float  value  )  [inline]

Set the specular coefficient. Parameters: value  the specular coefficient

void mitkSurfaceProperty::SetSpecularPower (  float  value  )  [inline]

Set the specular power. Parameters: value  the specular power (between 0.0 and 128.0)

void mitkSurfaceProperty::SetUnmodified (   )  [inline]

Reset to unmodified after changes have been done according to the new properties.

---

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

• mitkSurfaceProperty.h

---