Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

sedris::seDRMImage Class Reference

#include <seDRMImage.h>

Inheritance diagram for sedris::seDRMImage:

Inheritance graph
[legend]
Collaboration diagram for sedris::seDRMImage:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 seDRMImage ()
 Default constructor.

 seDRMImage (const seObject &other)
 Constructor for seDRM... class conversions.

const SE_String & get_name ()
 get field name

void set_name (const SE_String &val)
 set field name

void set_name (const SE_Character *chars, SE_Short_Integer_Unsigned len=0, SE_Locale locale=SE_LOCALE_DEFAULT)
 set field name by parameter list

SE_Colour_Model get_colour_model ()
 get field colour_model

void set_colour_model (SE_Colour_Model val)
 set field colour_model

SE_Short_Integer_Positive get_level_count ()
 get field level_count

void set_level_count (SE_Short_Integer_Positive val)
 set field level_count

const SE_Image_MIP_Extents * get_mip_extents_array ()
 get field mip_extents_array

void set_mip_extents_array (const SE_Image_MIP_Extents *mip_extents_array, SE_Short_Integer_Positive level_count)
 set field mip_extents_array

SE_Image_Signature get_image_signature ()
 get field image_signature

void set_image_signature (SE_Image_Signature val)
 set field image_signature

SE_Image_Scan_Direction get_scan_direction ()
 get field scan_direction

void set_scan_direction (SE_Image_Scan_Direction val)
 set field scan_direction

SE_Image_Scan_Direction_Z get_scan_direction_z ()
 get field scan_direction_z

void set_scan_direction_z (SE_Image_Scan_Direction_Z val)
 set field scan_direction_z

SE_Image_Component_Type get_component_data_type ()
 get field component_data_type

void set_component_data_type (SE_Image_Component_Type val)
 set field component_data_type

SE_Boolean get_data_is_little_endian ()
 get field data_is_little_endian

void set_data_is_little_endian (SE_Boolean val)
 set field data_is_little_endian

SE_Boolean get_data_is_3D ()
 get field data_is_3D

void set_data_is_3D (SE_Boolean val)
 set field data_is_3D

SE_Short_Integer_Unsigned get_bits_of_alpha ()
 get field bits_of_alpha

void set_bits_of_alpha (SE_Short_Integer_Unsigned val)
 set field bits_of_alpha

SE_Short_Integer_Unsigned get_bits_of_luminance ()
 get field bits_of_luminance

void set_bits_of_luminance (SE_Short_Integer_Unsigned val)
 set field bits_of_luminance

SE_Short_Integer_Unsigned get_bits_of_colour_coordinate_1 ()
 get field bits_of_colour_coordinate_1

void set_bits_of_colour_coordinate_1 (SE_Short_Integer_Unsigned val)
 set field bits_of_colour_coordinate_1

SE_Short_Integer_Unsigned get_bits_of_colour_coordinate_2 ()
 get field bits_of_colour_coordinate_2

void set_bits_of_colour_coordinate_2 (SE_Short_Integer_Unsigned val)
 set field bits_of_colour_coordinate_2

SE_Short_Integer_Unsigned get_bits_of_colour_coordinate_3 ()
 get field bits_of_colour_coordinate_3

void set_bits_of_colour_coordinate_3 (SE_Short_Integer_Unsigned val)
 set field bits_of_colour_coordinate_3

SE_Short_Integer_Unsigned get_bits_of_bump_map_height ()
 get field bits_of_bump_map_height

void set_bits_of_bump_map_height (SE_Short_Integer_Unsigned val)
 set field bits_of_bump_map_height

SE_Short_Integer_Unsigned get_bits_of_material_1 ()
 get field bits_of_material_1

void set_bits_of_material_1 (SE_Short_Integer_Unsigned val)
 set field bits_of_material_1

SE_Short_Integer_Unsigned get_bits_of_material_2 ()
 get field bits_of_material_2

void set_bits_of_material_2 (SE_Short_Integer_Unsigned val)
 set field bits_of_material_2

SE_Short_Integer_Unsigned get_bits_of_material_3 ()
 get field bits_of_material_3

void set_bits_of_material_3 (SE_Short_Integer_Unsigned val)
 set field bits_of_material_3

SE_Short_Integer_Unsigned get_bits_of_material_2_percentage ()
 get field bits_of_material_2_percentage

void set_bits_of_material_2_percentage (SE_Short_Integer_Unsigned val)
 set field bits_of_material_2_percentage

SE_Short_Integer_Unsigned get_bits_of_material_3_percentage ()
 get field bits_of_material_3_percentage

void set_bits_of_material_3_percentage (SE_Short_Integer_Unsigned val)
 set field bits_of_material_3_percentage

SE_Short_Integer_Unsigned get_bits_of_image_index ()
 get field bits_of_image_index

void set_bits_of_image_index (SE_Short_Integer_Unsigned val)
 set field bits_of_image_index

SE_Short_Integer_Unsigned get_bits_of_bump_map_u ()
 get field bits_of_bump_map_u

void set_bits_of_bump_map_u (SE_Short_Integer_Unsigned val)
 set field bits_of_bump_map_u

SE_Short_Integer_Unsigned get_bits_of_bump_map_v ()
 get field bits_of_bump_map_v

void set_bits_of_bump_map_v (SE_Short_Integer_Unsigned val)
 set field bits_of_bump_map_v

SE_Float get_min_value_of_alpha ()
 get field min_value_of_alpha

void set_min_value_of_alpha (SE_Float val)
 set field min_value_of_alpha

SE_Float get_max_value_of_alpha ()
 get field max_value_of_alpha

void set_max_value_of_alpha (SE_Float val)
 set field max_value_of_alpha

SE_Float get_min_value_of_luminance ()
 get field min_value_of_luminance

void set_min_value_of_luminance (SE_Float val)
 set field min_value_of_luminance

SE_Float get_max_value_of_luminance ()
 get field max_value_of_luminance

void set_max_value_of_luminance (SE_Float val)
 set field max_value_of_luminance

SE_Float get_min_value_of_colour_coordinate_1 ()
 get field min_value_of_colour_coordinate_1

void set_min_value_of_colour_coordinate_1 (SE_Float val)
 set field min_value_of_colour_coordinate_1

SE_Float get_max_value_of_colour_coordinate_1 ()
 get field max_value_of_colour_coordinate_1

void set_max_value_of_colour_coordinate_1 (SE_Float val)
 set field max_value_of_colour_coordinate_1

SE_Float get_min_value_of_colour_coordinate_2 ()
 get field min_value_of_colour_coordinate_2

void set_min_value_of_colour_coordinate_2 (SE_Float val)
 set field min_value_of_colour_coordinate_2

SE_Float get_max_value_of_colour_coordinate_2 ()
 get field max_value_of_colour_coordinate_2

void set_max_value_of_colour_coordinate_2 (SE_Float val)
 set field max_value_of_colour_coordinate_2

SE_Float get_min_value_of_colour_coordinate_3 ()
 get field min_value_of_colour_coordinate_3

void set_min_value_of_colour_coordinate_3 (SE_Float val)
 set field min_value_of_colour_coordinate_3

SE_Float get_max_value_of_colour_coordinate_3 ()
 get field max_value_of_colour_coordinate_3

void set_max_value_of_colour_coordinate_3 (SE_Float val)
 set field max_value_of_colour_coordinate_3

SE_Float get_min_value_of_bump_map_height ()
 get field min_value_of_bump_map_height

void set_min_value_of_bump_map_height (SE_Float val)
 set field min_value_of_bump_map_height

SE_Float get_max_value_of_bump_map_height ()
 get field max_value_of_bump_map_height

void set_max_value_of_bump_map_height (SE_Float val)
 set field max_value_of_bump_map_height

SE_Float get_min_value_of_bump_map_u ()
 get field min_value_of_bump_map_u

void set_min_value_of_bump_map_u (SE_Float val)
 set field min_value_of_bump_map_u

SE_Float get_max_value_of_bump_map_u ()
 get field max_value_of_bump_map_u

void set_max_value_of_bump_map_u (SE_Float val)
 set field max_value_of_bump_map_u

SE_Float get_min_value_of_bump_map_v ()
 get field min_value_of_bump_map_v

void set_min_value_of_bump_map_v (SE_Float val)
 set field min_value_of_bump_map_v

SE_Float get_max_value_of_bump_map_v ()
 get field max_value_of_bump_map_v

void set_max_value_of_bump_map_v (SE_Float val)
 set field max_value_of_bump_map_v

virtual void putImageData (SE_Short_Integer_Unsigned mip_level, SE_Integer_Unsigned byte_count, const unsigned char *data)
virtual void getImageData (SE_Short_Integer_Unsigned mip_level, SE_Integer_Unsigned byte_count, unsigned char *data)
virtual SE_Integer_Unsigned getImageDataSize (SE_Short_Integer_Unsigned mip_level)
virtual SE_DRM_Class getClassType () const
 Image class identification.

Detailed Description

seDRMImage wraps the DRM <Image> class.
Author:
Warren Macchi
Version:
Revision
1.7
See also:
seDRMBase

Constructor & Destructor Documentation

sedris::seDRMImage::seDRMImage (   )  [inline]
 

sedris::seDRMImage::seDRMImage (  const seObject &  other  )  [inline]
 

Member Function Documentation

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_alpha (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_bump_map_height (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_bump_map_u (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_bump_map_v (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_colour_coordinate_1 (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_colour_coordinate_2 (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_colour_coordinate_3 (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_image_index (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_luminance (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_material_1 (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_material_2 (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_material_2_percentage (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_material_3 (   )  [inline]
 

SE_Short_Integer_Unsigned sedris::seDRMImage::get_bits_of_material_3_percentage (   )  [inline]
 

SE_Colour_Model sedris::seDRMImage::get_colour_model (   )  [inline]
 

SE_Image_Component_Type sedris::seDRMImage::get_component_data_type (   )  [inline]
 

SE_Boolean sedris::seDRMImage::get_data_is_3D (   )  [inline]
 

SE_Boolean sedris::seDRMImage::get_data_is_little_endian (   )  [inline]
 

SE_Image_Signature sedris::seDRMImage::get_image_signature (   )  [inline]
 

SE_Short_Integer_Positive sedris::seDRMImage::get_level_count (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_alpha (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_bump_map_height (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_bump_map_u (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_bump_map_v (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_colour_coordinate_1 (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_colour_coordinate_2 (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_colour_coordinate_3 (   )  [inline]
 

SE_Float sedris::seDRMImage::get_max_value_of_luminance (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_alpha (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_bump_map_height (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_bump_map_u (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_bump_map_v (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_colour_coordinate_1 (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_colour_coordinate_2 (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_colour_coordinate_3 (   )  [inline]
 

SE_Float sedris::seDRMImage::get_min_value_of_luminance (   )  [inline]
 

const SE_Image_MIP_Extents* sedris::seDRMImage::get_mip_extents_array (   )  [inline]
 

const SE_String& sedris::seDRMImage::get_name (   )  [inline]
 

SE_Image_Scan_Direction sedris::seDRMImage::get_scan_direction (   )  [inline]
 

SE_Image_Scan_Direction_Z sedris::seDRMImage::get_scan_direction_z (   )  [inline]
 

virtual SE_DRM_Class sedris::seDRMImage::getClassType (   )  const [inline, virtual]
 

Reimplemented from sedris::seObject.

virtual void sedris::seDRMImage::getImageData (  SE_Short_Integer_Unsigned  mip_level,
SE_Integer_Unsigned  byte_count,
unsigned char *  data
)  [virtual]
 

Gets the image data from an Image's MIP level. See the seHelperImage class for an easier interface for reading image data.

User retrieves the image data from data, which is a pointer to byte_count bytes allocated by the user. Data can only be retrieved from one MIP level at a time.

Note:
byte_count MUST match the number of bytes in the MIP level, or an exception will occur.
See also:
getImageDataSize()
Parameters:
mip_level in: the image MIP level being accessed
byte_count in: the number of bytes in the MIP level
data in/out: the pointer to the image data
See also:
seHelperImage

virtual SE_Integer_Unsigned sedris::seDRMImage::getImageDataSize (  SE_Short_Integer_Unsigned  mip_level  )  [virtual]
 

Returns the number of bytes in an Image's MIP level.

Parameters:
mip_level in: the image MIP level being accessed
Returns:
number of bytes in MIP level (computed from fields)
See also:
seHelperImage

virtual void sedris::seDRMImage::putImageData (  SE_Short_Integer_Unsigned  mip_level,
SE_Integer_Unsigned  byte_count,
const unsigned char *  data
)  [virtual]
 

Sets the image data for an Image's MIP level. User provides the image data in data, which is a pointer to byte_count bytes allocated by the user.

Note:
byte_count MUST match the number of bytes in the MIP level, or an exception will occur.
See also:
getImageData(), getImageDataSize()
Parameters:
mip_level in: the image MIP level being accessed
byte_count in: the number of bytes in the MIP level
data in: the pointer to the image data

void sedris::seDRMImage::set_bits_of_alpha (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_bump_map_height (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_bump_map_u (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_bump_map_v (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_colour_coordinate_1 (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_colour_coordinate_2 (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_colour_coordinate_3 (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_image_index (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_luminance (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_material_1 (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_material_2 (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_material_2_percentage (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_material_3 (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_bits_of_material_3_percentage (  SE_Short_Integer_Unsigned  val  )  [inline]
 

void sedris::seDRMImage::set_colour_model (  SE_Colour_Model  val  )  [inline]
 

void sedris::seDRMImage::set_component_data_type (  SE_Image_Component_Type  val  )  [inline]
 

void sedris::seDRMImage::set_data_is_3D (  SE_Boolean  val  )  [inline]
 

void sedris::seDRMImage::set_data_is_little_endian (  SE_Boolean  val  )  [inline]
 

void sedris::seDRMImage::set_image_signature (  SE_Image_Signature  val  )  [inline]
 

void sedris::seDRMImage::set_level_count (  SE_Short_Integer_Positive  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_alpha (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_bump_map_height (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_bump_map_u (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_bump_map_v (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_colour_coordinate_1 (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_colour_coordinate_2 (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_colour_coordinate_3 (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_max_value_of_luminance (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_alpha (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_bump_map_height (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_bump_map_u (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_bump_map_v (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_colour_coordinate_1 (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_colour_coordinate_2 (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_colour_coordinate_3 (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_min_value_of_luminance (  SE_Float  val  )  [inline]
 

void sedris::seDRMImage::set_mip_extents_array (  const SE_Image_MIP_Extents *  mip_extents_array,
SE_Short_Integer_Positive  level_count
)  [inline]
 

void sedris::seDRMImage::set_name (  const SE_Character *  chars,
SE_Short_Integer_Unsigned  len = 0,
SE_Locale  locale = SE_LOCALE_DEFAULT
)  [inline]
 

void sedris::seDRMImage::set_name (  const SE_String &  val  )  [inline]
 

void sedris::seDRMImage::set_scan_direction (  SE_Image_Scan_Direction  val  )  [inline]
 

void sedris::seDRMImage::set_scan_direction_z (  SE_Image_Scan_Direction_Z  val  )  [inline]
 

The documentation for this class was generated from the following file:
SEDRIS Transmittal Access C++ API 4.0.0 beta - 14 Jul 2004
Copyright © 2004 SEDRIS™ Docs by Doxygen 1.3.2