mi::shader_v3::Map_field_type Class Reference

Map_field_type class. The Map_field_type is an enumerative class which is meant to list all possible field types for maps. More...

#include <shader_map.h>

List of all members.

Public Types

enum  Type {
  Undefined = 0,
  Scalar,
  Integer,
  Vector,
  Color,
  Transform,
  Scalar_array = 16,
  Integer_array
}
 all the map field types. More...

Public Member Functions

 Map_field_type ()
 constructor, unassigned Type.
 Map_field_type (Type type)
 constructor from a Type.
 Map_field_type (const Map_field_type &type)
 copy constructor.
Map_field_type & operator= (const Type &rhs)
 copy assignment operator (Type).
Map_field_type & operator= (const Map_field_type &rhs)
 copy assignment operator (Map_field_type).
bool operator== (const Type rhs) const
 equality operator (Type).
bool operator== (const Map_field_type &rhs) const
 equality operator (Map_field_type).
bool operator!= (const Type rhs) const
 inequality operator (Type).
bool operator!= (const Map_field_type &rhs) const
 inequality operator (Map_field_type).
Type type () const
 returns the field type as Type.

Detailed Description

Map_field_type class. The Map_field_type is an enumerative class which is meant to list all possible field types for maps.

Member Enumeration Documentation

enum mi::shader_v3::Map_field_type::Type
 

all the map field types.

Enumeration values:
Undefined  undefined type
Scalar  single-precision float
Integer  integer
Vector  3-dimensional vector (XYZ)
Color  4-dimensional color (RGBA)
Transform  4x4 matrix
Scalar_array  array of single-precision floats
Integer_array  array of integers

Constructor & Destructor Documentation

mi::shader_v3::Map_field_type::Map_field_type (  Type  type  )  [inline]
 

constructor from a Type.

Parameters:
type is the assigned Type

mi::shader_v3::Map_field_type::Map_field_type (  const Map_field_type &  type  )  [inline]
 

copy constructor.

Parameters:
type is the Map_field_type to copy

Member Function Documentation

bool mi::shader_v3::Map_field_type::operator!= (  const Map_field_type &  rhs  )  const [inline]
 

inequality operator (Map_field_type).

Parameters:
rhs is the Map_field_type to compare to
Returns:
true if different, false if equal

bool mi::shader_v3::Map_field_type::operator!= (  const Type  rhs  )  const [inline]
 

inequality operator (Type).

Parameters:
rhs is the Type to compare to
Returns:
true if different, false if equal

Map_field_type& mi::shader_v3::Map_field_type::operator= (  const Map_field_type &  rhs  )  [inline]
 

copy assignment operator (Map_field_type).

Parameters:
rhs the Map_field_type to copy
Returns:
a reference to itself

Map_field_type& mi::shader_v3::Map_field_type::operator= (  const Type &  rhs  )  [inline]
 

copy assignment operator (Type).

Parameters:
rhs the Type to copy
Returns:
a reference to itself

bool mi::shader_v3::Map_field_type::operator== (  const Map_field_type &  rhs  )  const [inline]
 

equality operator (Map_field_type).

Parameters:
rhs is the Map_field_type to compare to
Returns:
true if equal, false if different

bool mi::shader_v3::Map_field_type::operator== (  const Type  rhs  )  const [inline]
 

equality operator (Type).

Parameters:
rhs is the Type to compare to
Returns:
true if equal, false if different

Type mi::shader_v3::Map_field_type::type (   )  const [inline]
 

returns the field type as Type.

Returns:
the field type as a Type

Copyright © 1986-2009 by mental images GmbH