TK_Texture Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Texture:

Inheritance graph
[legend]
Collaboration diagram for TK_Texture:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Texture opcode.

TK_Texture provides support for writing/reading the TKE_Texture opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports 'textures', which define an image that can be applied to a HOOPS/3dGS shell or mesh primitive.

Definition at line 7177 of file BOpcodeHandler.h.

Public Member Functions

 TK_Texture ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void) alter
void SetName (char const *name) alter
void SetName (int length) alter
char const * GetName (void) const
char alter * GetName (void) alter
void SetImage (char const *image) alter
void SetImage (int length) alter
char const * GetImage (void) const
char alter * GetImage (void) alter
void SetFlags (int f) alter
int GetFlags (void) const
void SetParameterSource (int p) alter
int GetParameterSource (void) const
void SetInterpolation (int p) alter
int GetInterpolation (void) const
void SetDecimation (int p) alter
int GetDecimation (void) const
void SetRedMapping (int p) alter
int GetRedMapping (void) const
void SetGreenMapping (int p) alter
int GetGreenMapping (void) const
void SetBlueMapping (int p) alter
int GetBlueMapping (void) const
void SetAlphaMapping (int p) alter
int GetAlphaMapping (void) const
void SetParameterFunction (int p) alter
int GetParameterFunction (void) const
void SetLayout (int p) alter
int GetLayout (void) const
void SetTiling (int p) alter
int GetTiling (void) const
void SetValueScale (float v1, float v2) alter
float const * GetValueScale (void) const
void SetApplicationMode (int p) alter
int GetApplicationMode (void) const
void SetParameterOffset (int p) alter
int GetParameterOffset (void) const
void SetTransform (char const *transform) alter
void SetTransform (int length) alter
char const * GetTransform (void) const
char alter * GetTransform (void) alter

Protected Member Functions

void set_name (int length) alter
 for internal use only
void set_name (char const *name) alter
 for internal use only
void set_image (int length) alter
 for internal use only
void set_image (char const *image) alter
 for internal use only
void set_transform (int length) alter
 for internal use only
void set_transform (char const *transform) alter
 for internal use only

Protected Attributes

int m_name_length
int m_image_length
char * m_name
char * m_image
int m_flags
int m_substage
char m_param_source
char m_interpolation
char m_decimation
char m_red_mapping
char m_green_mapping
char m_blue_mapping
char m_alpha_mapping
char m_param_function
char m_layout
char m_tiling
float m_value_scale [2]
char * m_transform
char m_apply_mode
char m_param_offset


Constructor & Destructor Documentation

TK_Texture::TK_Texture  )  [inline]
 

constructor

Definition at line 7214 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Texture::Clone BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler
const [virtual]
 

Copies the opcode handler

Parameters:
tk A reference to the BStreamFileToolkit object.
handler A pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

int TK_Texture::GetAlphaMapping void   )  const [inline]
 

Returns the alpha channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7291 of file BOpcodeHandler.h.

int TK_Texture::GetApplicationMode void   )  const [inline]
 

Returns the decal & modulate mode. Tiling modes are specified in TKO_Texture_Application_Modes.

Definition at line 7316 of file BOpcodeHandler.h.

int TK_Texture::GetBlueMapping void   )  const [inline]
 

Returns the blue channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7286 of file BOpcodeHandler.h.

int TK_Texture::GetDecimation void   )  const [inline]
 

Returns the decimation filter. Filter types are defined in TKO_Texture_Filters.

Definition at line 7271 of file BOpcodeHandler.h.

int TK_Texture::GetFlags void   )  const [inline]
 

Returns the mask indicating which texture options are specified. Options are defined in TKO_Texture_Option_Bits.

Definition at line 7256 of file BOpcodeHandler.h.

int TK_Texture::GetGreenMapping void   )  const [inline]
 

Returns the green channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7281 of file BOpcodeHandler.h.

char alter* TK_Texture::GetImage void   )  [inline]
 

Returns the image name buffer, which can be modified directly

Definition at line 7247 of file BOpcodeHandler.h.

char const* TK_Texture::GetImage void   )  const [inline]
 

Returns the image name

Definition at line 7245 of file BOpcodeHandler.h.

int TK_Texture::GetInterpolation void   )  const [inline]
 

Returns the interpolation filter. Filter types are defined in TKO_Texture_Filters.

Definition at line 7266 of file BOpcodeHandler.h.

int TK_Texture::GetLayout void   )  const [inline]
 

Returns the layout of the data in the image. Layouts are specified in TKO_Texture_Layouts.

Definition at line 7301 of file BOpcodeHandler.h.

char alter* TK_Texture::GetName void   )  [inline]
 

Returns the texture name buffer, which can be modified directly

Definition at line 7238 of file BOpcodeHandler.h.

char const* TK_Texture::GetName void   )  const [inline]
 

Returns the texture name

Definition at line 7236 of file BOpcodeHandler.h.

int TK_Texture::GetParameterFunction void   )  const [inline]
 

Returns the parameterization function. Functions are defined in TKO_Texture_Param_Functions.

Definition at line 7296 of file BOpcodeHandler.h.

int TK_Texture::GetParameterOffset void   )  const [inline]
 

Returns the parameter offset.

Definition at line 7321 of file BOpcodeHandler.h.

int TK_Texture::GetParameterSource void   )  const [inline]
 

Returns the parameterization source. Options are defined in TKO_Texture_Param_Sources

Definition at line 7261 of file BOpcodeHandler.h.

int TK_Texture::GetRedMapping void   )  const [inline]
 

Returns the red channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7276 of file BOpcodeHandler.h.

int TK_Texture::GetTiling void   )  const [inline]
 

Returns the texture tiling mode. Tiling modes are specified in TKO_Texture_Tilings.

Definition at line 7306 of file BOpcodeHandler.h.

char alter* TK_Texture::GetTransform void   )  [inline]
 

Returns the transform segment name buffer, which may be modified directly

Definition at line 7336 of file BOpcodeHandler.h.

char const* TK_Texture::GetTransform void   )  const [inline]
 

Returns the transform segment name

Definition at line 7334 of file BOpcodeHandler.h.

float const* TK_Texture::GetValueScale void   )  const [inline]
 

Returns the value scale & offset factors

Definition at line 7311 of file BOpcodeHandler.h.

TK_Status TK_Texture::Read BStreamFileToolkit tk  )  [virtual]
 

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Texture::Reset void   )  [virtual]
 

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

Reimplemented from BBaseOpcodeHandler.

void TK_Texture::SetAlphaMapping int  p  )  [inline]
 

Sets the alpha channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7289 of file BOpcodeHandler.h.

void TK_Texture::SetApplicationMode int  p  )  [inline]
 

Sets the decal & modulate modes. Modes are specified in TKO_Texture_Application_Modes.

Definition at line 7314 of file BOpcodeHandler.h.

void TK_Texture::SetBlueMapping int  p  )  [inline]
 

Sets the blue channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7284 of file BOpcodeHandler.h.

void TK_Texture::SetDecimation int  p  )  [inline]
 

Sets the decimation filter. Filter types are defined in TKO_Texture_Filters.

Definition at line 7269 of file BOpcodeHandler.h.

void TK_Texture::SetFlags int  f  )  [inline]
 

Sets the mask indicating which texture options are specified. Options are defined in TKO_Texture_Option_Bits.

Definition at line 7250 of file BOpcodeHandler.h.

void TK_Texture::SetGreenMapping int  p  )  [inline]
 

Sets the green channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7279 of file BOpcodeHandler.h.

void TK_Texture::SetImage int  length  )  [inline]
 

Sets the image name buffer. Allocates a buffer large enough to hold a string of 'length' characters

Definition at line 7243 of file BOpcodeHandler.h.

void TK_Texture::SetImage char const *  image  )  [inline]
 

Sets the image name. Allocates the buffer and copies the name string

Definition at line 7241 of file BOpcodeHandler.h.

void TK_Texture::SetInterpolation int  p  )  [inline]
 

Sets the interpolation filter. Filter types are defined in TKO_Texture_Filters.

Definition at line 7264 of file BOpcodeHandler.h.

void TK_Texture::SetLayout int  p  )  [inline]
 

Sets the layout of the data in the image. Layouts are specified in TKO_Texture_Layouts.

Definition at line 7299 of file BOpcodeHandler.h.

void TK_Texture::SetName int  length  )  [inline]
 

Sets the texture name buffer. Allocates a buffer large enough to hold a string of 'length' characters

Definition at line 7234 of file BOpcodeHandler.h.

void TK_Texture::SetName char const *  name  )  [inline]
 

Sets the texture name. Allocates the buffer and copies the name string

Definition at line 7232 of file BOpcodeHandler.h.

void TK_Texture::SetParameterFunction int  p  )  [inline]
 

Sets the parameterization function. Functions are defined in TKO_Texture_Param_Functions.

Definition at line 7294 of file BOpcodeHandler.h.

void TK_Texture::SetParameterOffset int  p  )  [inline]
 

Sets the parameter offset.

Definition at line 7319 of file BOpcodeHandler.h.

void TK_Texture::SetParameterSource int  p  )  [inline]
 

Sets the parameterization source. Options are defined in TKO_Texture_Param_Sources

Definition at line 7259 of file BOpcodeHandler.h.

void TK_Texture::SetRedMapping int  p  )  [inline]
 

Sets the red channel mapping. Mappings are defined in TKO_Texture_Channel_Mappings.

Definition at line 7274 of file BOpcodeHandler.h.

void TK_Texture::SetTiling int  p  )  [inline]
 

Sets the texture tiling mode. Tiling modes are specified in TKO_Texture_Tilings.

Definition at line 7304 of file BOpcodeHandler.h.

void TK_Texture::SetTransform int  length  )  [inline]
 

Sets the buffer to contain the name of a transform segment. Allocates a buffer large enough to hold 'length' characters

Definition at line 7332 of file BOpcodeHandler.h.

void TK_Texture::SetTransform char const *  transform  )  [inline]
 

Sets the name of the segment containing a texture transform matrix. Allocates the buffer and copies the string

Definition at line 7327 of file BOpcodeHandler.h.

void TK_Texture::SetValueScale float  v1,
float  v2
[inline]
 

Sets the value scale & offset factors

Definition at line 7309 of file BOpcodeHandler.h.

TK_Status TK_Texture::Write BStreamFileToolkit tk  )  [virtual]
 

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

char TK_Texture::m_alpha_mapping [protected]
 

internal use; Method for remapping alpha channel value

Definition at line 7196 of file BOpcodeHandler.h.

char TK_Texture::m_apply_mode [protected]
 

internal use; bits showing setting of decal and/or modulate

Definition at line 7202 of file BOpcodeHandler.h.

char TK_Texture::m_blue_mapping [protected]
 

internal use; Method for remapping blue channel value

Definition at line 7195 of file BOpcodeHandler.h.

char TK_Texture::m_decimation [protected]
 

internal use; Method of pixel decimation (pixel covers large portion of texture)

Definition at line 7192 of file BOpcodeHandler.h.

int TK_Texture::m_flags [protected]
 

internal use; Flags indicating presence of optional values

Definition at line 7187 of file BOpcodeHandler.h.

char TK_Texture::m_green_mapping [protected]
 

internal use; Method for remapping green channel value

Definition at line 7194 of file BOpcodeHandler.h.

char* TK_Texture::m_image [protected]
 

internal use; Source image name

Definition at line 7186 of file BOpcodeHandler.h.

int TK_Texture::m_image_length [protected]
 

internal use; Current image name length

Definition at line 7184 of file BOpcodeHandler.h.

char TK_Texture::m_interpolation [protected]
 

internal use; Method of pixel interpolation (pixel falls between texture samples)

Definition at line 7191 of file BOpcodeHandler.h.

char TK_Texture::m_layout [protected]
 

internal use; Format of "picture" within source image

Definition at line 7198 of file BOpcodeHandler.h.

char* TK_Texture::m_name [protected]
 

internal use; Texture name

Definition at line 7185 of file BOpcodeHandler.h.

int TK_Texture::m_name_length [protected]
 

internal use; current name length

Definition at line 7183 of file BOpcodeHandler.h.

char TK_Texture::m_param_function [protected]
 

internal use; Basic parameter remapping methods

Definition at line 7197 of file BOpcodeHandler.h.

char TK_Texture::m_param_offset [protected]
 

internal use; offset into parameter value array

Definition at line 7203 of file BOpcodeHandler.h.

char TK_Texture::m_param_source [protected]
 

internal use; Source of parameters used for texture lookup

Definition at line 7190 of file BOpcodeHandler.h.

char TK_Texture::m_red_mapping [protected]
 

internal use; Method for remapping red channel value

Definition at line 7193 of file BOpcodeHandler.h.

int TK_Texture::m_substage [protected]
 

internal use: write/read progress

Definition at line 7188 of file BOpcodeHandler.h.

char TK_Texture::m_tiling [protected]
 

internal use; Handling of parametric values outside 0 to 1 range

Definition at line 7199 of file BOpcodeHandler.h.

char* TK_Texture::m_transform [protected]
 

internal use; Segment containing transform matrix

Definition at line 7201 of file BOpcodeHandler.h.

float TK_Texture::m_value_scale[2] [protected]
 

internal use; "Brightness & Contrast" scaling of texture values

Definition at line 7200 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:47 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5