TK_Rendering_Options Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Rendering_Options:

Inheritance graph
[legend]
Collaboration diagram for TK_Rendering_Options:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Rendering_Options opcode.

TK_Rendering_Options provides support for writing/reading the TKE_Rendering_Options opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports an attribute called Rendering_Options which control how the scene is rendered. Refer to the HOOPS/3dGS documentation for details of this attribute.

Definition at line 2950 of file BOpcodeHandler.h.

Public Member Functions

 TK_Rendering_Options ()
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 SetMask (int m0, int m1=0) alter
int GetMask (int index=0) const
void SetValue (int v0, int v1=0) alter
int GetValue (int index=0) const
void SetHSR (int h) alter
int GetHSR (void) const
void SetTransparentHSR (int t) alter
int GetTransparentHSR (void) const
void SetTransparentStyle (int s) alter
int GetTransparentStyle (void) const
void SetTechnology (int t) alter
int GetTechnology (void) const
void SetQuantization (int q) alter
int GetQuantization (void) const
void SetDebug (int d) alter
int GetDebug (void) const
void SetFaceDisplacement (int d) alter
int GetFaceDisplacement (void) const
void SetGeneralDisplacement (int d) alter
int GetGeneralDisplacement (void) const
void SetJoinCutoffAngle (int d) alter
int GetJoinCutoffAngle (void) const
void SetFogLimits (float n, float f) alter
void SetFogLimits (float const *l) alter
float const * GetFogLimits (void) const
void SetLockMask (int m) alter
int GetLockMask (void) const
void SetLockValue (int v) alter
int GetLockValue (void) const
void SetVisibilityLockMask (int m) alter
int GetVisibilityLockMask (void) const
void SetVisibilityLockValue (int v) alter
int GetVisibilityLockValue (void) const
void SetColorLockMask (int m) alter
int GetColorLockMask (void) const
void SetColorLockValue (int v) alter
int GetColorLockValue (void) const
void SetColorFaceLockMask (int m) alter
int GetColorFaceLockMask (void) const
void SetColorFaceLockValue (int v) alter
int GetColorFaceLockValue (void) const
void SetColorEdgeLockMask (int m) alter
int GetColorEdgeLockMask (void) const
void SetColorEdgeLockValue (int v) alter
int GetColorEdgeLockValue (void) const
void SetColorLineLockMask (int m) alter
int GetColorLineLockMask (void) const
void SetColorLineLockValue (int v) alter
int GetColorLineLockValue (void) const
void SetColorMarkerLockMask (int m) alter
int GetColorMarkerLockMask (void) const
void SetColorMarkerLockValue (int v) alter
int GetColorMarkerLockValue (void) const
void SetColorTextLockMask (int m) alter
int GetColorTextLockMask (void) const
void SetColorTextLockValue (int v) alter
int GetColorTextLockValue (void) const
void SetColorWindowLockMask (int m) alter
int GetColorWindowLockMask (void) const
void SetColorWindowLockValue (int v) alter
int GetColorWindowLockValue (void) const
void SetColorFaceContrastLockMask (int m) alter
int GetColorFaceContrastLockMask (void) const
void SetColorFaceContrastLockValue (int v) alter
int GetColorFaceContrastLockValue (void) const
void SetColorWindowContrastLockMask (int m) alter
int GetColorWindowContrastLockMask (void) const
void SetColorWindowContrastLockValue (int v) alter
int GetColorWindowContrastLockValue (void) const
void SetColorBackLockMask (int m) alter
int GetColorBackLockMask (void) const
void SetColorBackLockValue (int v) alter
int GetColorBackLockValue (void) const
void SetColorVertexLockMask (int m) alter
int GetColorVertexLockMask (void) const
void SetColorVertexLockValue (int v) alter
int GetColorVertexLockValue (void) const
void SetColorEdgeContrastLockMask (int m) alter
int GetColorEdgeContrastLockMask (void) const
void SetColorEdgeContrastLockValue (int v) alter
int GetColorEdgeContrastLockValue (void) const
void SetColorLineContrastLockMask (int m) alter
int GetColorLineContrastLockMask (void) const
void SetColorLineContrastLockValue (int v) alter
int GetColorLineContrastLockValue (void) const
void SetColorMarkerContrastLockMask (int m) alter
int GetColorMarkerContrastLockMask (void) const
void SetColorMarkerContrastLockValue (int v) alter
int GetColorMarkerContrastLockValue (void) const
void SetColorVertexContrastLockMask (int m) alter
int GetColorVertexContrastLockMask (void) const
void SetColorVertexContrastLockValue (int v) alter
int GetColorVertexContrastLockValue (void) const
void SetColorTextContrastLockMask (int m) alter
int GetColorTextContrastLockMask (void) const
void SetColorTextContrastLockValue (int v) alter
int GetColorTextContrastLockValue (void) const
void SetBufferOptionsMask (int v) alter
int GetBufferOptionsMask (void) const
void SetBufferOptionsValue (int v) alter
int GetBufferOptionsValue (void) const
void SetBufferSizeLimit (int l) alter
int GetBufferSizeLimit (void) const
void SetStereoSeparation (float s) alter
float GetStereoSeparation (void) const
void SetStereoDistance (float d) alter
float GetStereoDistance (void) const
void SetHlrOptions (int o) alter
int GetHlrOptions (void) const
void SetHlrDimFactor (float d) alter
float GetHlrDimFactor (void) const
void SetHlrFaceDisplacement (float d) alter
float GetHlrFaceDisplacement (void) const
void SetHlrLinePattern (int p) alter
int GetHlrLinePattern (void) const
void SetHlrFaceSortingAlgorithm (int a) alter
float GetHlrFaceSortingAlgorithm (void) const
void SetNURBSOptionsMask (int m) alter
int GetNURBSOptionsMask (void) const
void SetNURBSOptionsValue (int v) alter
int GetNURBSOptionsValue (void) const
void SetNURBSCurveBudget (int b) alter
int GetNURBSCurveBudget (void) const
void SetNURBSCurveContinuedBudget (int b) alter
int GetNURBSCurveContinuedBudget (void) const
void SetNURBSSurfaceBudget (int b) alter
int GetNURBSSurfaceBudget (void) const
void SetNURBSSurfaceTrimBudget (int b) alter
int GetNURBSSurfaceTrimBudget (void) const
void SetLodOptionsMask (int v) alter
int GetLodOptionsMask (void) const
void SetLodOptionsValue (int v) alter
int GetLodOptionsValue (void) const
void SetLodAlgorithm (int v) alter
int GetLodAlgorithm (void) const
void SetLodMinimumTriangleCount (int v) alter
int GetLodMinimumTriangleCount (void) const
void SetLodNumLevels (int v) alter
int GetLodNumLevels (void) const
void SetLodClamp (int v) alter
int GetLodClamp (void) const
void SetLodMaxDegree (int v) alter
int GetLodMaxDegree (void) const
void SetLodTolerance (float v) alter
float GetLodTolerance (void) const
void SetLodFallback (int v) alter
int GetLodFallback (void) const
void SetLodBounding (float x1, float y1, float z1, float x2, float y2, float z2) alter
void SetLodBounding (float const *s, float const *e) alter
void SetLodBounding (float const *p) alter
float const * GetLodBounding (void) const
void SetLodRatio (float r) alter
void SetLodRatios (int c, float const *r=0) alter
int GetLodNumRatios (void) const
float const * GetLodRatios (void) const
float alter * GetLodRatios (void) alter
void SetLodThresholdType (int v) alter
int GetLodThresholdType (void) const
void SetLodThreshold (float r) alter
void SetLodThresholds (int c, float const *r=0) alter
int GetLodNumThresholds (void) const
float const * GetLodThresholds (void) const
float alter * GetLodThresholds (void) alter
void SetLodCutoff (float r) alter
void SetLodCutoffs (int c, float const *r=0) alter
int GetLodNumCutoffs (void) const
float const * GetLodCutoffs (void) const
float alter * GetLodCutoffs (void) alter
void SetTessellationMask (int m) alter
int GetTessellationMask (void) const
void SetCylinderTessellation (int n) alter
void SetCylinderTessellations (int c, char const *n=0) alter
int GetNumCylinderTessellations (void) const
char const * GetCylinderTessellations (void) const
char alter * GetCylinderTessellations (void) alter
void SetSphereTessellation (int n) alter
void SetSphereTessellations (int c, char const *n=0) alter
int GetNumSphereTessellations (void) const
char const * GetSphereTessellations (void) const
char alter * GetSphereTessellations (void) alter
void SetGeometryOptionsMask (int m) alter
int GetGeometryOptionsMask (void) const
void SetHardEdgeAngle (int m) alter
float GetHardEdgeAngle (void) const
void SetMaskTransform (int m) alter
int GetMaskTransform (void) const
void SetCutGeometry (int m) alter
int GetCutGeometry (void) const
void SetCutGeometryLevel (int m) alter
int GetCutGeometryLevel (void) const
void SetCutGeometryColorMatch (int m) alter
int GetCutGeometryColorMatch (void) const
void SetCutGeometryTolerance (float m) alter
float GetCutGeometryTolerance (void) const
void SetDisplayListLevel (int m) alter
int GetDisplayListLevel (void) const
void SetSimpleShadow (int m) alter
int GetSimpleShadow (void) const
void SetSimpleShadowBlur (int m) alter
int GetSimpleShadowBlur (void) const
void SetSimpleShadowResolution (int m) alter
int GetSimpleShadowResolution (void) const
void SetSimpleShadowLight (float x, float y, float z) alter
void SetSimpleShadowLight (float const *l) alter
float const * getSimpleShadowLight (void) const
void SetSimpleShadowPlane (float a, float b, float c, float d) alter
void SetSimpleShadowPlane (float const *p) alter
float const * GetSimpleShadowPlane (void) const
void SetSimpleShadowColor (float r, float g, float b) alter
void SetSimpleShadowColor (float const *rgb) alter
float const * GetSimpleShadowColor (void) const
void SetSimpleShadowOpacity (float o) alter
float GetSimpleShadowOpacity (void) const
void SetShadowMap (int m) alter
int GetShadowMap (void) const
void SetShadowMapResolution (int m) alter
int GetShadowMapResolution (void) const
void SetShadowMapSamples (int m) alter
int GetShadowMapSamples (void) const
void SetSimpleReflection (int m) alter
int GetSimpleReflection (void) const
void SetSimpleReflectionPlane (float a, float b, float c, float d) alter
void SetSimpleReflectionPlane (float const *p) alter
float const * GetSimpleReflectionPlane (void) const
void SetSimpleReflectionOpacity (float o) alter
float GetSimpleReflectionOpacity (void) const
void SetDepthRange (float n, float f) alter
void SetDepthRange (float const *l) alter
float const * GetDepthRange (void) const
void SetScreenRange (float l, float r, float b, float t) alter
void SetScreenRange (float const *l) alter
float const * GetScreenRange (void) const
void SetImageScale (float x, float y) alter
void SetImageScale (float const *s) alter
float const * GetImageScale (void) const
void SetImageTintColor (float r, float g, float b) alter
void SetImageTintColor (float const *rgb) alter
float const * GetImageTintColor (void) const

Protected Attributes

int m_mask [2]
 internal use; specifies which rendering options are active (and hence, which are valid). For internal use only.
int m_value [2]
 internal use; specifies what values to set for boolean options. For internal use only.
unsigned char m_hsr
 internal use; low half hsr, high half thsr. For internal use only.
unsigned char m_tq
 internal use; low half technology, high half quantization. For internal use only.
int m_debug
 For internal use only.
int m_face_displacement
 For internal use only.
float m_fog_limits [2]
 For internal use only.
int m_lock_mask
 For internal use only.
int m_lock_value
 For internal use only.
int m_lock_color_mask
 For internal use only.
int m_lock_color_value
 For internal use only.
short m_lock_color_face_mask
 For internal use only.
short m_lock_color_face_value
 For internal use only.
short m_lock_color_edge_mask
 For internal use only.
short m_lock_color_edge_value
 For internal use only.
short m_lock_color_line_mask
 For internal use only.
short m_lock_color_line_value
 For internal use only.
short m_lock_color_marker_mask
 For internal use only.
short m_lock_color_marker_value
 For internal use only.
short m_lock_color_text_mask
 For internal use only.
short m_lock_color_text_value
 For internal use only.
short m_lock_color_window_mask
 For internal use only.
short m_lock_color_window_value
 For internal use only.
short m_lock_color_face_contrast_mask
 For internal use only.
short m_lock_color_face_contrast_value
 For internal use only.
short m_lock_color_window_contrast_mask
 For internal use only.
short m_lock_color_window_contrast_value
 For internal use only.
short m_lock_color_back_mask
 For internal use only.
short m_lock_color_back_value
 For internal use only.
short m_lock_color_vertex_mask
 For internal use only.
short m_lock_color_vertex_value
 For internal use only.
short m_lock_color_edge_contrast_mask
 For internal use only.
short m_lock_color_edge_contrast_value
 For internal use only.
short m_lock_color_line_contrast_mask
 For internal use only.
short m_lock_color_line_contrast_value
 For internal use only.
short m_lock_color_marker_contrast_mask
 For internal use only.
short m_lock_color_marker_contrast_value
 For internal use only.
short m_lock_color_vertex_contrast_mask
 For internal use only.
short m_lock_color_vertex_contrast_value
 For internal use only.
short m_lock_color_text_contrast_mask
 For internal use only.
short m_lock_color_text_contrast_value
 For internal use only.
short m_lock_color_simple_reflection_mask
 For internal use only.
short m_lock_color_simple_reflection_value
 For internal use only.
short m_lock_color_cut_face_mask
 For internal use only.
short m_lock_color_cut_face_value
 For internal use only.
short m_lock_color_cut_edge_mask
 For internal use only.
short m_lock_color_cut_edge_value
 For internal use only.
int m_lock_visibility_mask
 For internal use only.
int m_lock_visibility_value
 For internal use only.
unsigned char m_buffer_options_mask
 For internal use only.
unsigned char m_buffer_options_value
 For internal use only.
int m_buffer_size_limit
 For internal use only.
int m_hlr_options
 For internal use only.
float m_hlr_dim_factor
 For internal use only.
float m_hlr_face_displacement
 For internal use only.
int m_hlr_line_pattern
 For internal use only.
float m_hlr_color [3]
 for internal use only.
float m_hlr_weight
 for internal use only.
unsigned char m_hlr_weight_units
 for internal use only.
unsigned char m_hlr_hsr_algorithm
 for internal use only.
int m_lod_options_mask
 For internal use only.
int m_lod_options_value
 For internal use only.
char m_lod_algorithm
 For internal use only.
char m_num_ratios
 For internal use only.
float m_ratio [8]
 For internal use only.
char m_num_thresholds
 For internal use only.
float m_threshold [8]
 For internal use only.
char m_threshold_type
 For internal use only.
int m_min_triangle_count
 For internal use only.
unsigned char m_clamp
 For internal use only.
unsigned char m_num_levels
 For internal use only.
int m_max_degree
 For internal use only.
float m_tolerance
 For internal use only.
float m_bounding [6]
 For internal use only.
char m_num_cutoffs
 For internal use only.
float m_cutoff [8]
 For internal use only.
unsigned char m_heuristic
 For internal use only.
unsigned char m_fallback
 For internal use only.
int m_nurbs_options_mask
 For internal use only.
int m_nurbs_options_value
 For internal use only.
int m_curve_budget
 For internal use only.
int m_curve_continued_budget
 For internal use only.
int m_surface_budget
 For internal use only.
int m_surface_trim_budget
 For internal use only.
float m_surface_max_trim_curve_deviation
 For internal use only.
float m_surface_max_facet_angle
 For internal use only.
float m_surface_max_facet_deviation
 For internal use only.
float m_surface_max_facet_width
 For internal use only.
float m_curve_max_angle
 For internal use only.
float m_curve_max_deviation
 For internal use only.
float m_curve_max_length
 For internal use only.
float m_stereo_separation
 For internal use only.
float m_stereo_distance
 For internal use only.
unsigned char m_tessellations
 For internal use only.
char m_num_cylinder
 For internal use only.
char m_cylinder [8]
 For internal use only.
char m_num_sphere
 For internal use only.
char m_sphere [8]
 For internal use only.
unsigned char m_transparency_options
 internal use; low half style, high half flags
unsigned char m_cut_geometry
 For internal use only.
unsigned char m_cut_geometry_level
 For internal use only.
unsigned char m_cut_geometry_match
 For internal use only.
float m_cut_geometry_tolerance
 For internal use only.
unsigned short m_simple_shadow
 For internal use only.
unsigned char m_simple_shadow_blur
 For internal use only.
unsigned short m_simple_shadow_resolution
 For internal use only.
float m_simple_shadow_plane [4]
 For internal use only.
float m_simple_shadow_light [3]
 For internal use only.
float m_simple_shadow_color [3]
 For internal use only.
float m_simple_shadow_opacity
unsigned char m_shadow_map
 For internal use only.
unsigned short m_shadow_map_resolution
 For internal use only.
unsigned char m_shadow_map_samples
 For internal use only.
unsigned short m_simple_reflection
 For internal use only.
float m_simple_reflection_plane [4]
 For internal use only.
float m_simple_reflection_opacity
 For internal use only.
int m_simple_reflection_blur
 For internal use only.
float m_simple_reflection_hither
 For internal use only.
float m_simple_reflection_yon
 For internal use only.
float m_depth_range [2]
 For internal use only.
float m_screen_range [4]
 For internal use only.
float m_image_scale [2]
 For internal use only.
unsigned char m_mask_transform
 For internal use only.
unsigned char m_geometry_options
 For internal use only.
float m_dihedral
 For internal use only.
float m_image_tint_color [3]
 For internal use only.
unsigned char m_depth_peeling_layers
 For internal use only.
float m_depth_peeling_min_area
 For internal use only.
int m_general_displacement
 For internal use only.
int m_join_cutoff_angle
 For internal use only.
unsigned char m_display_list_level
 For internal use only.


Constructor & Destructor Documentation

TK_Rendering_Options::TK_Rendering_Options  ) 
 

constructor


Member Function Documentation

TK_Status TK_Rendering_Options::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_Rendering_Options::GetBufferOptionsMask void   )  const [inline]
 

Returns the mask indicating which buffer options are set.

Definition at line 3598 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetBufferOptionsValue void   )  const [inline]
 

Returns the mask indicating which buffer options are "on".

Definition at line 3602 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetBufferSizeLimit void   )  const [inline]
 

Returns the size limit on the software frame buffer.

Definition at line 3606 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorBackLockMask void   )  const [inline]
 

Returns the mask indicating which back color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3441 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorBackLockValue void   )  const [inline]
 

Returns the value indicating which back color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3452 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorEdgeContrastLockMask void   )  const [inline]
 

Returns the mask indicating which edge_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3487 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorEdgeContrastLockValue void   )  const [inline]
 

Returns the value indicating which edge_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3498 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorEdgeLockMask void   )  const [inline]
 

Returns the mask indicating which edge color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3280 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorEdgeLockValue void   )  const [inline]
 

Returns the value indicating which edge color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3291 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorFaceContrastLockMask void   )  const [inline]
 

Returns the mask indicating which face_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3395 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorFaceContrastLockValue void   )  const [inline]
 

Returns the value indicating which face_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3406 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorFaceLockMask void   )  const [inline]
 

Returns the mask indicating which face color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3257 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorFaceLockValue void   )  const [inline]
 

Returns the value indicating which face color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3268 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorLineContrastLockMask void   )  const [inline]
 

Returns the mask indicating which line_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3510 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorLineContrastLockValue void   )  const [inline]
 

Returns the value indicating which line_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3521 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorLineLockMask void   )  const [inline]
 

Returns the mask indicating which line color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3303 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorLineLockValue void   )  const [inline]
 

Returns the value indicating which line color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3314 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorLockMask void   )  const [inline]
 

Returns the mask indicating which types of geometry have a color lock setting. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3234 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorLockValue void   )  const [inline]
 

Returns the mask indicating which geometry colors are locked. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3245 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorMarkerContrastLockMask void   )  const [inline]
 

Returns the mask indicating which marker_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3533 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorMarkerContrastLockValue void   )  const [inline]
 

Returns the value indicating which marker_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3544 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorMarkerLockMask void   )  const [inline]
 

Returns the mask indicating which marker color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3326 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorMarkerLockValue void   )  const [inline]
 

Returns the value indicating which marker color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3337 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorTextContrastLockMask void   )  const [inline]
 

Returns the mask indicating which text_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3579 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorTextContrastLockValue void   )  const [inline]
 

Returns the value indicating which text_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3590 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorTextLockMask void   )  const [inline]
 

Returns the mask indicating which text color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3349 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorTextLockValue void   )  const [inline]
 

Returns the value indicating which text color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3360 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorVertexContrastLockMask void   )  const [inline]
 

Returns the mask indicating which vertex_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3556 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorVertexContrastLockValue void   )  const [inline]
 

Returns the value indicating which vertex_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3567 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorVertexLockMask void   )  const [inline]
 

Returns the mask indicating which vertex color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3464 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorVertexLockValue void   )  const [inline]
 

Returns the value indicating which vertex color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3475 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorWindowContrastLockMask void   )  const [inline]
 

Returns the mask indicating which window_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3418 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorWindowContrastLockValue void   )  const [inline]
 

Returns the value indicating which window_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3429 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorWindowLockMask void   )  const [inline]
 

Returns the mask indicating which window color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3372 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetColorWindowLockValue void   )  const [inline]
 

Returns the value indicating which window color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3383 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetCutGeometry void   )  const [inline]
 

Returns the mask indicating which cut geometry options are set.

Definition at line 3846 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetCutGeometryColorMatch void   )  const [inline]
 

Returns the cut geometry color match option.

Definition at line 3856 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetCutGeometryLevel void   )  const [inline]
 

Returns the geometry level.

Definition at line 3851 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetCutGeometryTolerance void   )  const [inline]
 

Returns the cut geometry point matching tolerance.

Definition at line 3861 of file BOpcodeHandler.h.

char alter* TK_Rendering_Options::GetCylinderTessellations void   )  [inline]
 

Returns the cylinder tessellation values for surface generation as the address of a buffer which may be modified

Definition at line 3808 of file BOpcodeHandler.h.

char const* TK_Rendering_Options::GetCylinderTessellations void   )  const [inline]
 

Returns the cylinder tessellation values used for surface generation

Definition at line 3806 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetDebug void   )  const [inline]
 

Returns the debug options

Definition at line 3167 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetDepthRange void   )  const [inline]
 

Returns the depth range as the address of a float pair

Definition at line 3969 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetDisplayListLevel void   )  const [inline]
 

Returns the display list level.

Definition at line 3867 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetFaceDisplacement void   )  const [inline]
 

Returns the face displacement value

Definition at line 3172 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetFogLimits void   )  const [inline]
 

Returns the fog limits as the address of a float pair

Definition at line 3189 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetGeneralDisplacement void   )  const [inline]
 

Returns the general displacement value

Definition at line 3177 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetGeometryOptionsMask void   )  const [inline]
 

Returns the mask indicating which geometry options are set.

Definition at line 3830 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetHardEdgeAngle void   )  const [inline]
 

Returns the hard edge angle limit.

Definition at line 3835 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetHlrDimFactor void   )  const [inline]
 

Returns the dim factor used when hidden lines are displayed.

Definition at line 3633 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetHlrFaceDisplacement void   )  const [inline]
 

Returns the displacement used for faces during hidden line calculations.

Definition at line 3637 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetHlrFaceSortingAlgorithm void   )  const [inline]
 

Returns the displacement used for faces during hidden line calculations.

Definition at line 3645 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetHlrLinePattern void   )  const [inline]
 

Returns the mask indicating which hlr options are set.

Definition at line 3641 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetHlrOptions void   )  const [inline]
 

Returns the mask indicating which hlr options are set.

Definition at line 3629 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetHSR void   )  const [inline]
 

Returns the Hidden Surface Removal algorithm

Definition at line 3142 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetImageScale void   )  const [inline]
 

Returns the image scale factors as the address of a float pair

Definition at line 3986 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetImageTintColor void   )  const [inline]
 

Returns the rgb color value as the address of a float triplet

Definition at line 3995 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetJoinCutoffAngle void   )  const [inline]
 

Returns the join cutoff limit value

Definition at line 3182 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLockMask void   )  const [inline]
 

Returns the mask indicating which attributes have a lock setting. Lock settings are specified by TKO_Attribute_Lock_Bits.

Definition at line 3195 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLockValue void   )  const [inline]
 

Returns the mask indicating which attributes are locked. Lock settings are specified by TKO_Attribute_Lock_Bits.

Definition at line 3200 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodAlgorithm void   )  const [inline]
 

Returns the type of algorithm used for LOD generation

Definition at line 3689 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetLodBounding void   )  const [inline]
 

Returns the explicit LOD bounding volume as the address of an array of six floats

Definition at line 3727 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodClamp void   )  const [inline]
 

Returns the clamp level for LOD display

Definition at line 3701 of file BOpcodeHandler.h.

float alter* TK_Rendering_Options::GetLodCutoffs void   )  [inline]
 

Returns the cutoffs used for LOD generation as the address of a buffer which may be modified

Definition at line 3785 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetLodCutoffs void   )  const [inline]
 

Returns the cutoffs used for LOD generation

Definition at line 3783 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodFallback void   )  const [inline]
 

Returns the fallback method for LOD display selection

Definition at line 3713 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodMaxDegree void   )  const [inline]
 

Returns the maximum degree

Definition at line 3705 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodMinimumTriangleCount void   )  const [inline]
 

Returns the minimum triangle count for LOD generation

Definition at line 3693 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodNumCutoffs void   )  const [inline]
 

Returns the count of cutoffs used for LOD generation

Definition at line 3781 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodNumLevels void   )  const [inline]
 

Returns the number of LOD levels to generate

Definition at line 3697 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodNumRatios void   )  const [inline]
 

Returns the count of ratios used for LOD generation

Definition at line 3741 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodNumThresholds void   )  const [inline]
 

Returns the count of thresholds used for LOD generation

Definition at line 3763 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodOptionsMask void   )  const [inline]
 

Returns the mask indicating which LOD options are set.

Definition at line 3681 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodOptionsValue void   )  const [inline]
 

Returns the mask indicating which LOD options are "on".

Definition at line 3685 of file BOpcodeHandler.h.

float alter* TK_Rendering_Options::GetLodRatios void   )  [inline]
 

Returns the ratios used for LOD generation as the address of a buffer which may be modified

Definition at line 3745 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetLodRatios void   )  const [inline]
 

Returns the ratios used for LOD generation

Definition at line 3743 of file BOpcodeHandler.h.

float alter* TK_Rendering_Options::GetLodThresholds void   )  [inline]
 

Returns the thresholds used for LOD generation as the address of a buffer which may be modified

Definition at line 3767 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetLodThresholds void   )  const [inline]
 

Returns the thresholds used for LOD generation

Definition at line 3765 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetLodThresholdType void   )  const [inline]
 

Returns the method used to determine when a LOD is not worth generating

Definition at line 3750 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetLodTolerance void   )  const [inline]
 

Returns the tolerance for collapsing points

Definition at line 3709 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetMask int  index = 0  )  const [inline]
 

Returns the mask indicating which options have a setting

Definition at line 3132 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetMaskTransform void   )  const [inline]
 

Returns the mask indicating which transform components should be blocked.

Definition at line 3840 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNumCylinderTessellations void   )  const [inline]
 

Returns the count of cylinder tessellation values used for surface generation

Definition at line 3804 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNumSphereTessellations void   )  const [inline]
 

Returns the count of sphere tessellation values used for surface generation

Definition at line 3821 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNURBSCurveBudget void   )  const [inline]
 

Returns the point budget for NURBS curve tessellation.

Definition at line 3663 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNURBSCurveContinuedBudget void   )  const [inline]
 

Returns the point budget for NURBS curve tessellation.

Definition at line 3667 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNURBSOptionsMask void   )  const [inline]
 

Returns the mask indicating which NURBS options are set.

Definition at line 3655 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNURBSOptionsValue void   )  const [inline]
 

Returns the mask indicating which NURBS options are "on".

Definition at line 3659 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNURBSSurfaceBudget void   )  const [inline]
 

Returns the point budget for NURBS surface tessellation.

Definition at line 3671 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetNURBSSurfaceTrimBudget void   )  const [inline]
 

Returns the point budget for NURBS trim curve tessellation.

Definition at line 3675 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetQuantization void   )  const [inline]
 

Returns the quantization methods used when displaying on color-limited devices

Definition at line 3162 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetScreenRange void   )  const [inline]
 

Returns the screen range as the address of a float pair

Definition at line 3978 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetShadowMap void   )  const [inline]
 

Returns the mask indicating which shadow map options are set.

Definition at line 3928 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetShadowMapResolution void   )  const [inline]
 

Returns shadow map image resolution.

Definition at line 3933 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetShadowMapSamples void   )  const [inline]
 

Returns shadow map image resolution.

Definition at line 3938 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetSimpleReflection void   )  const [inline]
 

Returns the mask indicating which simple reflection options are set.

Definition at line 3944 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetSimpleReflectionOpacity void   )  const [inline]
 

Returns simple reflection opacity.

Definition at line 3961 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetSimpleReflectionPlane void   )  const [inline]
 

Returns the simple reflection projection plane as the address of a float array

Definition at line 3956 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetSimpleShadow void   )  const [inline]
 

Returns the mask indicating which simple shadow options are set.

Definition at line 3876 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetSimpleShadowBlur void   )  const [inline]
 

Returns simple shadow blur (softness) level.

Definition at line 3881 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetSimpleShadowColor void   )  const [inline]
 

Returns the rgb color value as the address of a float triplet

Definition at line 3917 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::getSimpleShadowLight void   )  const [inline]
 

Returns the simple shadow light direction as the address of a float array

Definition at line 3897 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetSimpleShadowOpacity void   )  const [inline]
 

Returns simple shadow opacity.

Definition at line 3922 of file BOpcodeHandler.h.

float const* TK_Rendering_Options::GetSimpleShadowPlane void   )  const [inline]
 

Returns the simple shadow projection plane as the address of a float array

Definition at line 3909 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetSimpleShadowResolution void   )  const [inline]
 

Returns simple shadow image resolution.

Definition at line 3886 of file BOpcodeHandler.h.

char alter* TK_Rendering_Options::GetSphereTessellations void   )  [inline]
 

Returns the sphere tessellation values for surface generation as the address of a buffer which may be modified

Definition at line 3825 of file BOpcodeHandler.h.

char const* TK_Rendering_Options::GetSphereTessellations void   )  const [inline]
 

Returns the sphere tessellation values used for surface generation

Definition at line 3823 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetStereoDistance void   )  const [inline]
 

Returns the focal distance for stereo viewing.

Definition at line 3616 of file BOpcodeHandler.h.

float TK_Rendering_Options::GetStereoSeparation void   )  const [inline]
 

Returns the eye separation for stereo viewing.

Definition at line 3612 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetTechnology void   )  const [inline]
 

Returns the general technology used for drawing

Definition at line 3157 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetTessellationMask void   )  const [inline]
 

Returns the mask indicating which tessellation options are set.

Definition at line 3791 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetTransparentHSR void   )  const [inline]
 

Returns the drawing style used for transparent components

Definition at line 3147 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetTransparentStyle void   )  const [inline]
 

Returns the Hidden Surface Removal algorithm used for transparent components

Definition at line 3152 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetValue int  index = 0  )  const [inline]
 

Returns the mask indicating which options are set on/active

Definition at line 3137 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetVisibilityLockMask void   )  const [inline]
 

Returns the mask indicating which types of geometry have a visibility lock setting. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3211 of file BOpcodeHandler.h.

int TK_Rendering_Options::GetVisibilityLockValue void   )  const [inline]
 

Returns the mask indicating which geometry visibilities are locked. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3222 of file BOpcodeHandler.h.

TK_Status TK_Rendering_Options::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_Rendering_Options::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_Rendering_Options::SetBufferOptionsMask int  v  )  [inline]
 

Sets the mask indicating which buffer options are set.

Definition at line 3596 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetBufferOptionsValue int  v  )  [inline]
 

Sets the mask indicating which buffer options are "on".

Definition at line 3600 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetBufferSizeLimit int  l  )  [inline]
 

Sets the size limit on the software frame buffer.

Definition at line 3604 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorBackLockMask int  m  )  [inline]
 

Sets the mask indicating which back color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3436 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorBackLockValue int  v  )  [inline]
 

Sets the value indicating which back color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3447 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorEdgeContrastLockMask int  m  )  [inline]
 

Sets the mask indicating which edge_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3482 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorEdgeContrastLockValue int  v  )  [inline]
 

Sets the value indicating which edge_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3493 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorEdgeLockMask int  m  )  [inline]
 

Sets the mask indicating which edge color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3275 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorEdgeLockValue int  v  )  [inline]
 

Sets the value indicating which edge color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3286 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorFaceContrastLockMask int  m  )  [inline]
 

Sets the mask indicating which face_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3390 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorFaceContrastLockValue int  v  )  [inline]
 

Sets the value indicating which face_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3401 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorFaceLockMask int  m  )  [inline]
 

Sets the mask indicating which face color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3252 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorFaceLockValue int  v  )  [inline]
 

Sets the value indicating which face color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3263 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorLineContrastLockMask int  m  )  [inline]
 

Sets the mask indicating which line_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3505 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorLineContrastLockValue int  v  )  [inline]
 

Sets the value indicating which line_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3516 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorLineLockMask int  m  )  [inline]
 

Sets the mask indicating which line color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3298 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorLineLockValue int  v  )  [inline]
 

Sets the value indicating which line color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3309 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorLockMask int  m  )  [inline]
 

Sets the mask indicating which types of geometry have a color lock setting. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3229 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorLockValue int  v  )  [inline]
 

Sets the mask indicating which geometry colors are locked. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3240 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorMarkerContrastLockMask int  m  )  [inline]
 

Sets the mask indicating which marker_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3528 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorMarkerContrastLockValue int  v  )  [inline]
 

Sets the value indicating which marker_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3539 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorMarkerLockMask int  m  )  [inline]
 

Sets the mask indicating which marker color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3321 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorMarkerLockValue int  v  )  [inline]
 

Sets the value indicating which marker color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3332 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorTextContrastLockMask int  m  )  [inline]
 

Sets the mask indicating which text_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3574 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorTextContrastLockValue int  v  )  [inline]
 

Sets the value indicating which text_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3585 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorTextLockMask int  m  )  [inline]
 

Sets the mask indicating which text color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3344 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorTextLockValue int  v  )  [inline]
 

Sets the value indicating which text color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3355 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorVertexContrastLockMask int  m  )  [inline]
 

Sets the mask indicating which vertex_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3551 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorVertexContrastLockValue int  v  )  [inline]
 

Sets the value indicating which vertex_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3562 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorVertexLockMask int  m  )  [inline]
 

Sets the mask indicating which vertex color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3459 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorVertexLockValue int  v  )  [inline]
 

Sets the value indicating which vertex color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3470 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorWindowContrastLockMask int  m  )  [inline]
 

Sets the mask indicating which window_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3413 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorWindowContrastLockValue int  v  )  [inline]
 

Sets the value indicating which window_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3424 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorWindowLockMask int  m  )  [inline]
 

Sets the mask indicating which window color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3367 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetColorWindowLockValue int  v  )  [inline]
 

Sets the value indicating which window color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.

Definition at line 3378 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetCutGeometry int  m  )  [inline]
 

Sets the mask indicating which cut geometry options to use.

Definition at line 3844 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetCutGeometryColorMatch int  m  )  [inline]
 

Sets the cut geometry color match option.

Definition at line 3854 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetCutGeometryLevel int  m  )  [inline]
 

Sets the cut geometry level.

Definition at line 3849 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetCutGeometryTolerance float  m  )  [inline]
 

Sets the cut geometry point matching tolerance.

Definition at line 3859 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetCylinderTessellation int  n  )  [inline]
 

Sets a single cylinder tessellation value used for surface generation

Definition at line 3793 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetCylinderTessellations int  c,
char const *  n = 0
[inline]
 

Sets the cylinder tessellation values used for surface generation

Definition at line 3795 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetDebug int  d  )  [inline]
 

Sets the debug options

Reimplemented from BBaseOpcodeHandler.

Definition at line 3165 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetDepthRange float const *  l  )  [inline]
 

Sets the depth range using a float pair

Definition at line 3967 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetDepthRange float  n,
float  f
[inline]
 

Sets the depth range using discrete values

Definition at line 3965 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetDisplayListLevel int  m  )  [inline]
 

Sets the display list level.

Definition at line 3865 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetFaceDisplacement int  d  )  [inline]
 

Sets the face displacement value

Definition at line 3170 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetFogLimits float const *  l  )  [inline]
 

Sets the fog limits using a float pair

Definition at line 3187 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetFogLimits float  n,
float  f
[inline]
 

Sets the fog limits using discrete values

Definition at line 3185 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetGeneralDisplacement int  d  )  [inline]
 

Sets the general displacement value

Definition at line 3175 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetGeometryOptionsMask int  m  )  [inline]
 

Sets the mask indicating which geometry options are set.

Definition at line 3828 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetHardEdgeAngle int  m  )  [inline]
 

Sets the value of the hard edge angle limit.

Definition at line 3833 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetHlrDimFactor float  d  )  [inline]
 

Sets the dim factor used when hidden lines are displayed.

Definition at line 3631 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetHlrFaceDisplacement float  d  )  [inline]
 

Sets the displacement used for faces during hidden line calculations.

Definition at line 3635 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetHlrFaceSortingAlgorithm int  a  )  [inline]
 

Sets the displacement used for faces during hidden line calculations.

Definition at line 3643 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetHlrLinePattern int  p  )  [inline]
 

Sets the mask indicating which hlr options are set.

Definition at line 3639 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetHlrOptions int  o  )  [inline]
 

Sets the mask indicating which hlr options are set.

Definition at line 3620 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetHSR int  h  )  [inline]
 

Sets the Hidden Surface Removal algorithm

Definition at line 3140 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetImageScale float const *  s  )  [inline]
 

Sets the image scale factors using a float pair

Definition at line 3984 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetImageScale float  x,
float  y
[inline]
 

Sets the image scale factors using discrete values

Definition at line 3982 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetImageTintColor float const *  rgb  )  [inline]
 

Sets the rgb color value as a float triplet

Definition at line 3993 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetImageTintColor float  r,
float  g,
float  b
[inline]
 

Sets the rgb color value as discrete floats

Definition at line 3990 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetJoinCutoffAngle int  d  )  [inline]
 

Sets the join cutoff limit value

Definition at line 3180 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLockMask int  m  )  [inline]
 

Sets the mask indicating which attributes have a lock setting. Lock settings are specified by TKO_Attribute_Lock_Bits.

Definition at line 3193 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLockValue int  v  )  [inline]
 

Sets the mask indicating which attributes are locked. Lock settings are specified by TKO_Attribute_Lock_Bits.

Definition at line 3198 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodAlgorithm int  v  )  [inline]
 

Sets the type of algorithm used for LOD generation

Definition at line 3687 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodBounding float const *  p  )  [inline]
 

Sets the explicit LOD bounding volume using an array of 6 floats

Definition at line 3725 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodBounding float const *  s,
float const *  e
[inline]
 

Sets the explicit LOD bounding volume using discrete float triplets

Definition at line 3721 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodBounding float  x1,
float  y1,
float  z1,
float  x2,
float  y2,
float  z2
[inline]
 

Sets the explicit LOD bounding volume as discrete float values

Definition at line 3716 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodClamp int  v  )  [inline]
 

Sets the clamp level for LOD display

Definition at line 3699 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodCutoff float  r  )  [inline]
 

Sets a single cutoff used for LOD generation

Definition at line 3770 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodCutoffs int  c,
float const *  r = 0
[inline]
 

Sets the cutoffs used for LOD generation

Definition at line 3772 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodFallback int  v  )  [inline]
 

Sets the fallback method for LOD display selection

Definition at line 3711 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodMaxDegree int  v  )  [inline]
 

Sets the maximum degree

Definition at line 3703 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodMinimumTriangleCount int  v  )  [inline]
 

Sets the minimum triangle count for LOD generation

Definition at line 3691 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodNumLevels int  v  )  [inline]
 

Sets the number of LOD levels to generate

Definition at line 3695 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodOptionsMask int  v  )  [inline]
 

Sets the mask indicating which LOD options are set.

Definition at line 3679 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodOptionsValue int  v  )  [inline]
 

Sets the mask indicating which LOD options are "on".

Definition at line 3683 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodRatio float  r  )  [inline]
 

Sets a single ratio used for LOD generation

Definition at line 3730 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodRatios int  c,
float const *  r = 0
[inline]
 

Sets the ratios used for LOD generation

Definition at line 3732 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodThreshold float  r  )  [inline]
 

Sets a single threshold used for LOD generation

Definition at line 3752 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodThresholds int  c,
float const *  r = 0
[inline]
 

Sets the thresholds used for LOD generation

Definition at line 3754 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodThresholdType int  v  )  [inline]
 

Sets the method used to determine when a LOD is not worth generating

Definition at line 3748 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetLodTolerance float  v  )  [inline]
 

Sets the tolerance for collapsing points

Definition at line 3707 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetMask int  m0,
int  m1 = 0
[inline]
 

Sets the mask indicating which options have a setting

Definition at line 3125 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetMaskTransform int  m  )  [inline]
 

Sets the mask indicating which transform components should be blocked.

Definition at line 3838 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetNURBSCurveBudget int  b  )  [inline]
 

Sets the point budget for NURBS curve tessellation.

Definition at line 3661 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetNURBSCurveContinuedBudget int  b  )  [inline]
 

Sets the point budget for NURBS curve tessellation.

Definition at line 3665 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetNURBSOptionsMask int  m  )  [inline]
 

Sets the mask indicating which NURBS options are set.

Definition at line 3649 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetNURBSOptionsValue int  v  )  [inline]
 

Sets the mask indicating which NURBS options are "on".

Definition at line 3657 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetNURBSSurfaceBudget int  b  )  [inline]
 

Sets the point budget for NURBS surface tessellation.

Definition at line 3669 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetNURBSSurfaceTrimBudget int  b  )  [inline]
 

Sets the point budget for NURBS trim curve tessellation.

Definition at line 3673 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetQuantization int  q  )  [inline]
 

Sets the quantization methods used when displaying on color-limited devices

Definition at line 3160 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetScreenRange float const *  l  )  [inline]
 

Sets the screen range using a float pair

Definition at line 3976 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetScreenRange float  l,
float  r,
float  b,
float  t
[inline]
 

Sets the screen range using discrete values

Definition at line 3973 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetShadowMap int  m  )  [inline]
 

Sets the mask indicating which shadow map options to use.

Definition at line 3926 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetShadowMapResolution int  m  )  [inline]
 

Sets the shadow map image resolution.

Definition at line 3931 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetShadowMapSamples int  m  )  [inline]
 

Sets the shadow map image samples.

Definition at line 3936 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleReflection int  m  )  [inline]
 

Sets the mask indicating which simple reflection options to use.

Definition at line 3942 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleReflectionOpacity float  o  )  [inline]
 

Sets the simple reflection opacity.

Definition at line 3959 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleReflectionPlane float const *  p  )  [inline]
 

Sets the simple reflection projection plane using a float pair

Definition at line 3954 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleReflectionPlane float  a,
float  b,
float  c,
float  d
[inline]
 

Sets the simple reflection projection plane using discrete values

Definition at line 3947 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadow int  m  )  [inline]
 

Sets the mask indicating which simple shadow options to use.

Definition at line 3870 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowBlur int  m  )  [inline]
 

Sets the simple shadow blur (softness) level.

Definition at line 3879 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowColor float const *  rgb  )  [inline]
 

Sets the rgb color value as a float triplet

Definition at line 3915 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowColor float  r,
float  g,
float  b
[inline]
 

Sets the rgb color value as discrete floats

Definition at line 3912 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowLight float const *  l  )  [inline]
 

Sets the simple shadow light direction using a float pair

Definition at line 3895 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowLight float  x,
float  y,
float  z
[inline]
 

Sets the simple shadow light direction using discrete values

Definition at line 3889 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowOpacity float  o  )  [inline]
 

Sets the simple shadow opacity.

Definition at line 3920 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowPlane float const *  p  )  [inline]
 

Sets the simple shadow projection plane using a float pair

Definition at line 3907 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowPlane float  a,
float  b,
float  c,
float  d
[inline]
 

Sets the simple shadow projection plane using discrete values

Definition at line 3900 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSimpleShadowResolution int  m  )  [inline]
 

Sets the simple shadow image resolution.

Definition at line 3884 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSphereTessellation int  n  )  [inline]
 

Sets a single sphere tessellation value used for surface generation

Definition at line 3810 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetSphereTessellations int  c,
char const *  n = 0
[inline]
 

Sets the sphere tessellation values used for surface generation

Definition at line 3812 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetStereoDistance float  d  )  [inline]
 

Sets the focal distance for stereo viewing.

Definition at line 3614 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetStereoSeparation float  s  )  [inline]
 

Sets the eye separation for stereo viewing.

Definition at line 3610 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetTechnology int  t  )  [inline]
 

Sets the general technology used for drawing

Definition at line 3155 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetTessellationMask int  m  )  [inline]
 

Sets the mask indicating which tessellation options are set.

Definition at line 3789 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetTransparentHSR int  t  )  [inline]
 

Sets the drawing style used for transparent components

Definition at line 3145 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetTransparentStyle int  s  )  [inline]
 

Sets the Hidden Surface Removal algorithm used for transparent components

Definition at line 3150 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetValue int  v0,
int  v1 = 0
[inline]
 

Sets the mask indicating which options are set on/active

Definition at line 3135 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetVisibilityLockMask int  m  )  [inline]
 

Sets the mask indicating which types of geometry have a visibility lock setting. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3206 of file BOpcodeHandler.h.

void TK_Rendering_Options::SetVisibilityLockValue int  v  )  [inline]
 

Sets the mask indicating which geometry visibilities are locked. Geometry types are specified by TKO_Geometry_Bits.

Definition at line 3217 of file BOpcodeHandler.h.

TK_Status TK_Rendering_Options::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.


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