Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

HTK_Rendering_Options Class Reference

Provides HOOPS/3dGS-specific handling of the TKE_Rendering_Options opcode. More...

#include <HOpcodeHandler.h>

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
 
TK_Status Execute (BStreamFileToolkit &tk)
 
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0)
 
TK_Status Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special)
 
- Public Member Functions inherited from TK_Rendering_Options
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
 
float const * GetAmbientUpVector () const
 
int GetAntiAlias () const
 
int GetBufferOptionsMask () const
 
int GetBufferOptionsValue () const
 
int GetBufferSizeLimit () const
 
int GetColorBackForcedLockMask () const
 
int GetColorBackForcedLockValue () const
 
int GetColorBackLockMask () const
 
int GetColorBackLockValue () const
 
int GetColorEdgeContrastForcedLockMask () const
 
int GetColorEdgeContrastForcedLockValue () const
 
int GetColorEdgeContrastLockMask () const
 
int GetColorEdgeContrastLockValue () const
 
int GetColorEdgeForcedLockMask () const
 
int GetColorEdgeForcedLockValue () const
 
int GetColorEdgeLockMask () const
 
int GetColorEdgeLockValue () const
 
int GetColorFaceContrastForcedLockMask () const
 
int GetColorFaceContrastForcedLockValue () const
 
int GetColorFaceContrastLockMask () const
 
int GetColorFaceContrastLockValue () const
 
int GetColorFaceForcedLockMask () const
 
int GetColorFaceForcedLockValue () const
 
int GetColorFaceLockMask () const
 
int GetColorFaceLockValue () const
 
int GetColorForcedLockMask () const
 
int GetColorForcedLockValue () const
 
int GetColorLineContrastForcedLockMask () const
 
int GetColorLineContrastForcedLockValue () const
 
int GetColorLineContrastLockMask () const
 
int GetColorLineContrastLockValue () const
 
int GetColorLineForcedLockMask () const
 
int GetColorLineForcedLockValue () const
 
int GetColorLineLockMask () const
 
int GetColorLineLockValue () const
 
int GetColorLockMask () const
 
int GetColorLockValue () const
 
int GetColorMarkerContrastForcedLockMask () const
 
int GetColorMarkerContrastForcedLockValue () const
 
int GetColorMarkerContrastLockMask () const
 
int GetColorMarkerContrastLockValue () const
 
int GetColorMarkerForcedLockMask () const
 
int GetColorMarkerForcedLockValue () const
 
int GetColorMarkerLockMask () const
 
int GetColorMarkerLockValue () const
 
int GetColorTextContrastForcedLockMask () const
 
int GetColorTextContrastForcedLockValue () const
 
int GetColorTextContrastLockMask () const
 
int GetColorTextContrastLockValue () const
 
int GetColorTextForcedLockMask () const
 
int GetColorTextForcedLockValue () const
 
int GetColorTextLockMask () const
 
int GetColorTextLockValue () const
 
int GetColorVertexContrastForcedLockMask () const
 
int GetColorVertexContrastForcedLockValue () const
 
int GetColorVertexContrastLockMask () const
 
int GetColorVertexContrastLockValue () const
 
int GetColorVertexForcedLockMask () const
 
int GetColorVertexForcedLockValue () const
 
int GetColorVertexLockMask () const
 
int GetColorVertexLockValue () const
 
int GetColorWindowContrastForcedLockMask () const
 
int GetColorWindowContrastForcedLockValue () const
 
int GetColorWindowContrastLockMask () const
 
int GetColorWindowContrastLockValue () const
 
int GetColorWindowForcedLockMask () const
 
int GetColorWindowForcedLockValue () const
 
int GetColorWindowLockMask () const
 
int GetColorWindowLockValue () const
 
int GetCutGeometry () const
 
int GetCutGeometryColorMatch () const
 
char const * GetCutGeometryEdgePattern () const
 
char * GetCutGeometryEdgePattern ()
 
float GetCutGeometryEdgeWeight () const
 
int GetCutGeometryEdgeWeightUnits () const
 
int GetCutGeometryLevel () const
 
float GetCutGeometryTolerance () const
 
char const * GetCylinderTessellations () const
 
char * GetCylinderTessellations ()
 
int GetDebug () const
 
float const * GetDepthRange () const
 
float const * GetDiffuseTextureTintColor () const
 
int GetDisplayListLevel () const
 
int GetFaceDisplacement () const
 
float const * GetFogLimits () const
 
int GetForcedLockMask () const
 
int GetForcedLockValue () const
 
int GetGeneralDisplacement () const
 
int GetGeometryOptionsMask () const
 
float GetHardEdgeAngle () const
 
float GetHlrDimFactor () const
 
float GetHlrFaceDisplacement () const
 
float GetHlrFaceSortingAlgorithm () const
 
int GetHlrLinePattern () const
 
int GetHlrOptions () const
 
int GetHSR () const
 
float const * GetImageScale () const
 
float const * GetImageTintColor () const
 
int GetJoinCutoffAngle () const
 
int GetLockMask () const
 
int GetLockValue () const
 
int GetLodAlgorithm () const
 
float const * GetLodBounding () const
 
int GetLodClamp () const
 
float const * GetLodCutoffs () const
 
float * GetLodCutoffs ()
 
int GetLodFallback () const
 
int GetLodMaxDegree () const
 
int GetLodMinimumTriangleCount () const
 
int GetLodNumCutoffs () const
 
int GetLodNumLevels () const
 
int GetLodNumRatios () const
 
int GetLodNumThresholds () const
 
int GetLodOptionsMask () const
 
int GetLodOptionsValue () const
 
float const * GetLodRatios () const
 
float * GetLodRatios ()
 
float const * GetLodThresholds () const
 
float * GetLodThresholds ()
 
int GetLodThresholdType () const
 
float GetLodTolerance () const
 
int GetMask (int index=0) const
 
int GetMaskTransform () const
 
int GetNumCylinderTessellations () const
 
int GetNumSphereTessellations () const
 
int GetNURBSCurveBudget () const
 
int GetNURBSCurveContinuedBudget () const
 
int GetNURBSOptionsMask () const
 
int GetNURBSOptionsValue () const
 
int GetNURBSSurfaceBudget () const
 
int GetNURBSSurfaceTrimBudget () const
 
int GetQuantization () const
 
float const * GetScreenRange () const
 
int GetShadowMap () const
 
int GetShadowMapResolution () const
 
int GetShadowMapSamples () const
 
int GetSimpleReflection () const
 
float GetSimpleReflectionOpacity () const
 
float const * GetSimpleReflectionPlane () const
 
int GetSimpleReflectionVisibilityValue () const
 
int GetSimpleShadow () const
 
int GetSimpleShadowBlur () const
 
float const * GetSimpleShadowColor () const
 
float const * getSimpleShadowLight () const
 
float GetSimpleShadowOpacity () const
 
float const * GetSimpleShadowPlane () const
 
int GetSimpleShadowResolution () const
 
char const * GetSphereTessellations () const
 
char * GetSphereTessellations ()
 
float GetStereoDistance () const
 
float GetStereoSeparation () const
 
int GetTechnology () const
 
int GetTessellationMask () const
 
int GetTransparentHSR () const
 
int GetTransparentStyle () const
 
int GetValue (int index=0) const
 
float GetVertexDecimation () const
 
int GetVertexDisplacement () const
 
int GetVisibilityForcedLockMask () const
 
int GetVisibilityForcedLockValue () const
 
int GetVisibilityLockMask () const
 
int GetVisibilityLockValue () const
 
TK_Status Read (BStreamFileToolkit &tk)
 
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
 
void Reset ()
 
void SetAmbientUpVector (float x, float y, float z)
 
void SetAmbientUpVector (float const v[])
 
void SetAntiAlias (int m)
 
void SetBufferOptionsMask (int v)
 
void SetBufferOptionsValue (int v)
 
void SetBufferSizeLimit (int l)
 
void SetColorBackForcedLockMask (int m)
 
void SetColorBackForcedLockValue (int v)
 
void SetColorBackLockMask (int m)
 
void SetColorBackLockValue (int v)
 
void SetColorEdgeContrastForcedLockMask (int m)
 
void SetColorEdgeContrastForcedLockValue (int v)
 
void SetColorEdgeContrastLockMask (int m)
 
void SetColorEdgeContrastLockValue (int v)
 
void SetColorEdgeForcedLockMask (int m)
 
void SetColorEdgeForcedLockValue (int v)
 
void SetColorEdgeLockMask (int m)
 
void SetColorEdgeLockValue (int v)
 
void SetColorFaceContrastForcedLockMask (int m)
 
void SetColorFaceContrastForcedLockValue (int v)
 
void SetColorFaceContrastLockMask (int m)
 
void SetColorFaceContrastLockValue (int v)
 
void SetColorFaceForcedLockMask (int m)
 
void SetColorFaceForcedLockValue (int v)
 
void SetColorFaceLockMask (int m)
 
void SetColorFaceLockValue (int v)
 
void SetColorForcedLockMask (int m)
 
void SetColorForcedLockValue (int v)
 
void SetColorLineContrastForcedLockMask (int m)
 
void SetColorLineContrastForcedLockValue (int v)
 
void SetColorLineContrastLockMask (int m)
 
void SetColorLineContrastLockValue (int v)
 
void SetColorLineForcedLockMask (int m)
 
void SetColorLineForcedLockValue (int v)
 
void SetColorLineLockMask (int m)
 
void SetColorLineLockValue (int v)
 
void SetColorLockMask (int m)
 
void SetColorLockValue (int v)
 
void SetColorMarkerContrastForcedLockMask (int m)
 
void SetColorMarkerContrastForcedLockValue (int v)
 
void SetColorMarkerContrastLockMask (int m)
 
void SetColorMarkerContrastLockValue (int v)
 
void SetColorMarkerForcedLockMask (int m)
 
void SetColorMarkerForcedLockValue (int v)
 
void SetColorMarkerLockMask (int m)
 
void SetColorMarkerLockValue (int v)
 
void SetColorTextContrastForcedLockMask (int m)
 
void SetColorTextContrastForcedLockValue (int v)
 
void SetColorTextContrastLockMask (int m)
 
void SetColorTextContrastLockValue (int v)
 
void SetColorTextForcedLockMask (int m)
 
void SetColorTextForcedLockValue (int v)
 
void SetColorTextLockMask (int m)
 
void SetColorTextLockValue (int v)
 
void SetColorVertexContrastForcedLockMask (int m)
 
void SetColorVertexContrastForcedLockValue (int v)
 
void SetColorVertexContrastLockMask (int m)
 
void SetColorVertexContrastLockValue (int v)
 
void SetColorVertexForcedLockMask (int m)
 
void SetColorVertexForcedLockValue (int v)
 
void SetColorVertexLockMask (int m)
 
void SetColorVertexLockValue (int v)
 
void SetColorWindowContrastForcedLockMask (int m)
 
void SetColorWindowContrastForcedLockValue (int v)
 
void SetColorWindowContrastLockMask (int m)
 
void SetColorWindowContrastLockValue (int v)
 
void SetColorWindowForcedLockMask (int m)
 
void SetColorWindowForcedLockValue (int v)
 
void SetColorWindowLockMask (int m)
 
void SetColorWindowLockValue (int v)
 
void SetCutGeometry (int m)
 
void SetCutGeometryColorMatch (int m)
 
void SetCutGeometryEdgePattern (char const *pattern)
 
void SetCutGeometryEdgePattern (int length)
 
void SetCutGeometryEdgeWeight (float value, int units=TKO_Generic_Size_Unspecified)
 
void SetCutGeometryLevel (int m)
 
void SetCutGeometryTolerance (float m)
 
void SetCylinderTessellation (int n)
 
void SetCylinderTessellations (int c, char const *n=0)
 
void SetDebug (int d)
 
void SetDepthRange (float n, float f)
 
void SetDepthRange (float const l[])
 
void SetDiffuseTextureTintColor (float r, float g, float b)
 
void SetDiffuseTextureTintColor (float const rgb[])
 
void SetDisplayListLevel (int m)
 
void SetFaceDisplacement (int d)
 
void SetFogLimits (float n, float f)
 
void SetFogLimits (float const l[])
 
void SetForcedLockMask (int m)
 
void SetForcedLockValue (int v)
 
void SetGeneralDisplacement (int d)
 
void SetGeometryOptionsMask (int m)
 
void SetHardEdgeAngle (int m)
 
void SetHlrDimFactor (float d)
 
void SetHlrFaceDisplacement (float d)
 
void SetHlrFaceSortingAlgorithm (int a)
 
void SetHlrLinePattern (int p)
 
void SetHlrOptions (int o)
 
void SetHSR (int h)
 
void SetImageScale (float x, float y)
 
void SetImageScale (float const s[])
 
void SetImageTintColor (float r, float g, float b)
 
void SetImageTintColor (float const rgb[])
 
void SetJoinCutoffAngle (int d)
 
void SetLockMask (int m)
 
void SetLockValue (int v)
 
void SetLodAlgorithm (int v)
 
void SetLodBounding (float x1, float y1, float z1, float x2, float y2, float z2)
 
void SetLodBounding (float const s[], float const e[])
 
void SetLodBounding (float const p[])
 
void SetLodClamp (int v)
 
void SetLodCutoff (float r)
 
void SetLodCutoffs (int c, float const r[]=0)
 
void SetLodFallback (int v)
 
void SetLodMaxDegree (int v)
 
void SetLodMinimumTriangleCount (int v)
 
void SetLodNumLevels (int v)
 
void SetLodOptionsMask (int v)
 
void SetLodOptionsValue (int v)
 
void SetLodRatio (float r)
 
void SetLodRatios (int c, float const r[]=0)
 
void SetLodThreshold (float r)
 
void SetLodThresholds (int c, float const r[]=0)
 
void SetLodThresholdType (int v)
 
void SetLodTolerance (float v)
 
void SetMask (int m0, int m1=0, int m2=0)
 
void SetMaskTransform (int m)
 
void SetNURBSCurveBudget (int b)
 
void SetNURBSCurveContinuedBudget (int b)
 
void SetNURBSOptionsMask (int m)
 
void SetNURBSOptionsValue (int v)
 
void SetNURBSSurfaceBudget (int b)
 
void SetNURBSSurfaceTrimBudget (int b)
 
void SetQuantization (int q)
 
void SetScreenRange (float l, float r, float b, float t, float lo=0, float ro=0, float bo=0, float to=0)
 
void SetScreenRange (float const l[])
 
void SetScreenRange (float const l[], float const o[])
 
void SetScreenRange (int n, float const l[])
 
void SetShadowMap (int m)
 
void SetShadowMapResolution (int m)
 
void SetShadowMapSamples (int m)
 
void SetSimpleReflection (int m)
 
void SetSimpleReflectionOpacity (float o)
 
void SetSimpleReflectionPlane (float a, float b, float c, float d)
 
void SetSimpleReflectionPlane (float const p[])
 
void SetSimpleReflectionVisibilityMask (int m)
 
void SetSimpleShadow (int m)
 
void SetSimpleShadowBlur (int m)
 
void SetSimpleShadowColor (float r, float g, float b)
 
void SetSimpleShadowColor (float const rgb[])
 
void SetSimpleShadowLight (float x, float y, float z)
 
void SetSimpleShadowLight (float const l[])
 
void SetSimpleShadowOpacity (float o)
 
void SetSimpleShadowPlane (float a, float b, float c, float d)
 
void SetSimpleShadowPlane (float const p[])
 
void SetSimpleShadowResolution (int m)
 
void SetSphereTessellation (int n)
 
void SetSphereTessellations (int c, char const *n=0)
 
void SetStereoDistance (float d)
 
void SetStereoSeparation (float s)
 
void SetTechnology (int t)
 
void SetTessellationMask (int m)
 
void SetTransparentHSR (int t)
 
void SetTransparentStyle (int s)
 
void SetValue (int v0, int v1=0, int v2=0)
 
void SetVertexDecimation (float f)
 
void SetVertexDisplacement (int d)
 
void SetVisibilityForcedLockMask (int m)
 
void SetVisibilityForcedLockValue (int v)
 
void SetVisibilityLockMask (int m)
 
void SetVisibilityLockValue (int v)
 
 TK_Rendering_Options ()
 
TK_Status Write (BStreamFileToolkit &tk)
 
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.
 
- Public Member Functions inherited from BBaseOpcodeHandler
 BBaseOpcodeHandler (int op)
 
unsigned char General_Flags () const
 
char const * GetLoggingString () const
 
char * GetLoggingString ()
 
bool IsCollectionPart () const
 
void LogDebug (BStreamFileToolkit &tk, char const *string=0)
 
virtual bool Match_Instance (BStreamFileToolkit const &tk, Recorded_Instance *instance)
 
virtual bool NeedsContext (BStreamFileToolkit &tk) const
 
bool NeedsTag () const
 
unsigned char Opcode () const
 
int Pass (BStreamFileToolkit &tk) const
 
void Set_General_Flags (int f)
 
void SetCollectionPart (bool n)
 
void SetLoggingString (char const *segment)
 
void SetLoggingString (int length)
 
void SetNeedsTag (bool n)
 
TK_Status Tag (BStreamFileToolkit &tk, int variant=-1) const
 
bool Tagging (BStreamFileToolkit &tk) const
 
- Public Member Functions inherited from BControlledMemoryObject
void operator delete (void *p)
 force deallocation to happen in the stream toolkit's scope
 
void * operator new (size_t size)
 force allocation to happen in the stream toolkit's scope
 

Additional Inherited Members

- Protected Member Functions inherited from BBaseOpcodeHandler
void add_segment (BStreamFileToolkit &tk, ID_Key key)
 for internal use only
 
void adjust_written (BStreamFileToolkit &tk, int count)
 for internal use only
 
void bytes_to_floats (unsigned char const *in, float *out, int count) const
 for internal use only
 
void decrease_nesting (BStreamFileToolkit &tk, int amount=1)
 for internal use only
 
bool Find_Instance (BStreamFileToolkit &tk, int val1, int val2, int val3)
 
bool Find_Item (BStreamFileToolkit &tk, ID_Key key) const
 
void floats_to_bytes (float const *in, unsigned char *out, int count) const
 for internal use only
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, int *rInts, unsigned int n)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned char &value)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, char &value)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned short &value)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, short &value)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, int &value)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, float &value)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, float *rFloats, unsigned int n)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, char *m_string, unsigned int n)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned char *m_string, unsigned int n)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, int *rInts, unsigned int n)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, short *rShorts, unsigned int n)
 
TK_Status GetAsciiData (BStreamFileToolkit &tk, const char *tag, unsigned short *rShorts, unsigned int n)
 
TK_Status GetAsciiHex (BStreamFileToolkit &tk, const char *tag, unsigned char &value)
 
TK_Status GetAsciiHex (BStreamFileToolkit &tk, const char *tag, int &value)
 
TK_Status GetAsciiHex (BStreamFileToolkit &tk, const char *tag, char &value)
 
TK_Status GetAsciiHex (BStreamFileToolkit &tk, const char *tag, unsigned short &value)
 
TK_Status GetAsciiImageData (BStreamFileToolkit &tk, const char *tag, unsigned char *rValues, unsigned int n)
 
TK_Status GetGeneral (BStreamFileToolkit &tk)
 
void increase_nesting (BStreamFileToolkit &tk, int amount=1)
 for internal use only
 
ID_Key last_key (BStreamFileToolkit &tk) const
 obsolete
 
void log_opcode (BStreamFileToolkit &tk, unsigned int sequence, unsigned char opcode)
 for internal use only
 
BBaseOpcodeHandlerOpcode_Handler (BStreamFileToolkit &tk, unsigned char op) const
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, char const *b, int n)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, short const *s, int n)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, int const *i, int n)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, float const *f, int n)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned char const *b, int n)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned short const *s, int n)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned int const *i, int n)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, char const &c)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, short const &s)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, int const &i)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned char const &b)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned short const &s)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, unsigned int const &i)
 
TK_Status PutAsciiData (BStreamFileToolkit &tk, char const *tag, float const &f)
 
TK_Status PutAsciiFlag (BStreamFileToolkit &tk, char const *tag, int const &i)
 
TK_Status PutAsciiHex (BStreamFileToolkit &tk, char const *tag, int const &i)
 
TK_Status PutAsciiMask (BStreamFileToolkit &tk, char const *tag, int const &i)
 
TK_Status PutAsciiOpcode (BStreamFileToolkit &tk, int adjust=1, bool is_end=false, bool want_newline=true)
 
TK_Status PutEndXMLTag (BStreamFileToolkit &tk, char const *tag)
 
TK_Status PutGeneral (BStreamFileToolkit &tk)
 
TK_Status PutOpcode (BStreamFileToolkit &tk, int adjust=1)
 
TK_Status PutStartXMLTag (BStreamFileToolkit &tk, char const *tag)
 
TK_Status Read_Referenced_Segment (BStreamFileToolkit &tk, int &i_progress)
 
TK_Status ReadAsciiLine (BStreamFileToolkit &tk, unsigned int *readSize=0)
 
TK_Status ReadAsciiWord (BStreamFileToolkit &tk, unsigned int *readSize=0)
 
TK_Status ReadEndOpcode (BStreamFileToolkit &tk)
 
void Record_Instance (BStreamFileToolkit &tk, ID_Key key, int variant, int val1, int val2, int val3) const
 
void Remember_Item (BStreamFileToolkit &tk, ID_Key key) const
 
ID_Key remove_segment (BStreamFileToolkit &tk)
 for internal use only
 
bool RemoveAngularBrackets (char *string)
 
bool RemoveQuotes (char *string)
 
void Revisit (BStreamFileToolkit &tk, float priority=0.0f, int variant=0) const
 
void set_last_key (BStreamFileToolkit &tk, ID_Key key)
 sets the given key as "most recent" on the toolkit for the purposes of associating keys with indices
 
TK_Status SkipNewlineAndTabs (BStreamFileToolkit &tk, unsigned int *readSize=0)
 
bool validate_count (int count, int limit=1<< 24) const
 
- Static Protected Member Functions inherited from BBaseOpcodeHandler
static void fix (int *i, int n)
 for internal use only
 
static void fix (short *s, int n)
 for internal use only
 
static void fix_in (float *f, int n)
 for internal use only
 
static void fix_in (double *d, int n)
 for internal use only
 
static void fix_out (float *f, int n)
 for internal use only
 
static void fix_out (double *d, int n)
 for internal use only
 
static short flip (short s)
 for internal use only
 
static int flip (int i)
 for internal use only
 
static TK_Status GetData (BStreamFileToolkit &tk, char *b, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, short *s, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, int *i, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, float *f, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, double *d, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, unsigned char *b, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, unsigned short *s, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, unsigned int *i, int n)
 
static TK_Status GetData (BStreamFileToolkit &tk, char &c)
 
static TK_Status GetData (BStreamFileToolkit &tk, short &s)
 
static TK_Status GetData (BStreamFileToolkit &tk, int &i)
 
static TK_Status GetData (BStreamFileToolkit &tk, unsigned char &b)
 
static TK_Status GetData (BStreamFileToolkit &tk, unsigned short &s)
 
static TK_Status GetData (BStreamFileToolkit &tk, unsigned int &i)
 
static TK_Status GetData (BStreamFileToolkit &tk, float &f)
 
static TK_Status GetData (BStreamFileToolkit &tk, double &d)
 
static TK_Status LookatData (BStreamFileToolkit &tk, unsigned char &b)
 
static TK_Status PutData (BStreamFileToolkit &tk, char const *b, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, short const *s, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, int const *i, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, float const *f, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, double const *d, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, unsigned char const *b, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, unsigned short const *s, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, unsigned int const *i, int n)
 
static TK_Status PutData (BStreamFileToolkit &tk, char const &c)
 
static TK_Status PutData (BStreamFileToolkit &tk, short const &s)
 
static TK_Status PutData (BStreamFileToolkit &tk, int const &i)
 
static TK_Status PutData (BStreamFileToolkit &tk, unsigned char const &b)
 
static TK_Status PutData (BStreamFileToolkit &tk, unsigned short const &s)
 
static TK_Status PutData (BStreamFileToolkit &tk, unsigned int const &i)
 
static TK_Status PutData (BStreamFileToolkit &tk, float const &f)
 
static TK_Status PutData (BStreamFileToolkit &tk, double const &d)
 
static float read_float (char const *cp, char const **newcpp=0)
 
static float read_float (char const *cp, char **newcpp)
 for internal use only
 
static char * write_float (char *buffer, double f)
 for internal use only
 
- Protected Attributes inherited from TK_Rendering_Options
float m_ambient_up_vector [3]
 For internal use only.
 
unsigned char m_antialias
 For internal use only.
 
float m_bounding [6]
 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.
 
unsigned char m_clamp
 For internal use only.
 
unsigned short m_contour_options
 for internal use only.
 
char m_contour_value_adjustment
 for internal use only.
 
float m_contour_value_scale
 for internal use only.
 
float m_contour_value_translate
 for internal use only.
 
int m_curve_budget
 For internal use only.
 
int m_curve_continued_budget
 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.
 
unsigned char m_cut_geometry
 For internal use only.
 
char * m_cut_geometry_edge_pattern
 for internal use only.
 
int m_cut_geometry_edge_pattern_length
 for internal use only.
 
float m_cut_geometry_edge_weight
 for internal use only.
 
unsigned char m_cut_geometry_edge_weight_units
 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.
 
float m_cutoff [8]
 For internal use only.
 
char m_cylinder [8]
 For internal use only.
 
int m_debug
 For internal use only.
 
unsigned char m_depth_peeling_algorithm
 For internal use only.
 
unsigned char m_depth_peeling_layers
 For internal use only.
 
float m_depth_peeling_min_area
 For internal use only.
 
float m_depth_range [2]
 For internal use only.
 
float m_dihedral
 For internal use only.
 
unsigned char m_display_list_level
 For internal use only.
 
int m_edge_join_cutoff_angle
 For internal use only.
 
int m_extra
 
float m_eye_dome_lighting_back_color [3]
 For internal use only.
 
int m_face_displacement
 For internal use only.
 
unsigned char m_fallback
 For internal use only.
 
short m_fbe_mask
 For internal use only.
 
short m_fbe_value
 For internal use only.
 
float m_fog_limits [2]
 For internal use only.
 
Lock_Masks m_forced
 For internal use only.
 
int m_general_displacement
 For internal use only.
 
unsigned char m_geometry_options
 For internal use only.
 
char * m_gooch_color_map_segment
 For internal use only.
 
int m_gooch_color_map_segment_length
 
float m_gooch_color_range [2]
 For internal use only.
 
float m_gooch_diffuse_weight
 For internal use only.
 
unsigned char m_heuristic
 For internal use only.
 
float m_hlr_color [3]
 for internal use only.
 
float m_hlr_dim_factor
 For internal use only.
 
float m_hlr_face_displacement
 For internal use only.
 
unsigned char m_hlr_hsr_algorithm
 for internal use only.
 
int m_hlr_line_pattern
 For internal use only.
 
int m_hlr_options
 For internal use only.
 
float m_hlr_threshold
 for internal use only.
 
unsigned char m_hlr_threshold_units
 for internal use only.
 
float m_hlr_transparency_cutoff
 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_hsr
 internal use; low half hsr, high half thsr. For internal use only.
 
float m_image_scale [2]
 For internal use only.
 
float m_image_tint_color [3]
 For internal use only.
 
int m_isoline_color_count
 for internal use only.
 
float * m_isoline_colors
 for internal use only.
 
unsigned short m_isoline_options
 for internal use only.
 
int m_isoline_pattern_count
 for internal use only.
 
char ** m_isoline_patterns
 for internal use only.
 
int m_isoline_position_count
 for internal use only.
 
char m_isoline_position_type
 for internal use only.
 
float * m_isoline_positions
 for internal use only.
 
int m_isoline_weight_count
 for internal use only.
 
unsigned char * m_isoline_weights_unit
 for internal use only.
 
float * m_isoline_weights_value
 for internal use only.
 
int m_join_cutoff_angle
 For internal use only.
 
Lock_Masks m_lock
 For internal use only.
 
char m_lod_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_marker_drawing_preference
 For internal use only.
 
int m_mask [3]
 internal use; specifies which rendering options are active (and hence, which are valid). For internal use only.
 
unsigned short m_mask_transform
 For internal use only.
 
int m_max_degree
 For internal use only.
 
int m_min_triangle_count
 For internal use only.
 
char m_num_cutoffs
 For internal use only.
 
char m_num_cylinder
 For internal use only.
 
unsigned char m_num_levels
 For internal use only.
 
char m_num_ratios
 For internal use only.
 
char m_num_sphere
 For internal use only.
 
char m_num_thresholds
 For internal use only.
 
int m_nurbs_options_mask
 For internal use only.
 
int m_nurbs_options_value
 For internal use only.
 
float m_ratio [8]
 For internal use only.
 
float m_screen_range [8]
 For internal use only.
 
unsigned short 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.
 
int m_simple_reflection_blur
 For internal use only.
 
float m_simple_reflection_hither
 For internal use only.
 
float m_simple_reflection_opacity
 For internal use only.
 
float m_simple_reflection_plane [4]
 For internal use only.
 
int m_simple_reflection_visibility_mask
 For internal use only.
 
int m_simple_reflection_visibility_value
 For internal use only.
 
float m_simple_reflection_yon
 For internal use only.
 
unsigned short m_simple_shadow
 For internal use only.
 
unsigned char m_simple_shadow_blur
 For internal use only.
 
float m_simple_shadow_color [3]
 For internal use only.
 
float m_simple_shadow_light [3]
 For internal use only.
 
float m_simple_shadow_opacity
 
float m_simple_shadow_plane [4]
 For internal use only.
 
unsigned short m_simple_shadow_resolution
 For internal use only.
 
char m_sphere [8]
 For internal use only.
 
float m_stereo_distance
 For internal use only.
 
float m_stereo_separation
 For internal use only.
 
int m_surface_budget
 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_surface_max_trim_curve_deviation
 For internal use only.
 
int m_surface_trim_budget
 For internal use only.
 
unsigned char m_tessellations
 For internal use only.
 
float m_texture_tint_color [3]
 For internal use only.
 
float m_threshold [8]
 For internal use only.
 
char m_threshold_type
 For internal use only.
 
float m_tint_color [3]
 For internal use only.
 
char m_tint_effect
 For internal use only.
 
unsigned short m_tint_options
 For internal use only.
 
float m_tint_range [2]
 For internal use only.
 
float m_tolerance
 For internal use only.
 
unsigned char m_tq
 internal use; low half technology, high half quantization. For internal use only.
 
unsigned short m_transparency_options
 internal use; low nibble style, next peeling flags, then zsort
 
int m_value [3]
 internal use; specifies what values to set for boolean options. For internal use only.
 
float m_vertex_decimation
 For internal use only.
 
int m_vertex_displacement
 For internal use only.
 
- Protected Attributes inherited from BBaseOpcodeHandler
char * m_ascii_buffer
 
int m_ascii_length
 
int m_ascii_progress
 Tracks the amount of data that has been read/written so far by GetAscii functions.
 
int m_ascii_size
 
int m_ascii_stage
 
unsigned char m_byte
 temporary
 
char m_char
 temporary
 
bool m_collection_part
 Indicates if this object is part of a LOD collection.
 
int m_debug_allocated
 
int m_debug_length
 
char * m_debug_string
 
unsigned char m_general_flags
 Basic flags common to many handlers.
 
int m_int
 temporary
 
bool m_needs_tag
 Indicate if this object explicitly needs tagging.
 
unsigned char m_opcode
 The opcode being handled by this particular object.
 
int m_progress
 Tracks the amount of data that has been read/written so far.
 
int m_stage
 The writing stage.
 
unsigned short m_unsigned_short
 temporary
 

Detailed Description

Provides HOOPS/3dGS-specific handling of the TKE_Rendering_Options opcode.

This class complements the read/write functionality implemented in the base class by overloading the Interpret and Execute methods to provide HOOPS/3dGS-specific opcode handling.

Writing: The HOOPS/3dGS database is queried in the Interpret method, and this data is then written to the HSF file by the Write method Reading: The data is read from the HSF file by the Read method, and is mapped to the HOOPS/3dGS scene-graph within the Execute method.

Export/import of additional user-data (which is associated with this HSF object) would typically be done by overloading the Write and Read methods.

Member Function Documentation

TK_Status HTK_Rendering_Options::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const
virtual

Copies the opcode handler

Parameters
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Rendering_Options::Execute ( BStreamFileToolkit tk)
virtual

Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.

Parameters
tkA reference to the BStreamFileToolkit object.
Returns
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Rendering_Options::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
int  variant = 0 
)
virtual

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
variantoptional specification of an alternate form, such as a Level-of-Detail representation
Returns
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

TK_Status HTK_Rendering_Options::Interpret ( BStreamFileToolkit tk,
ID_Key  key,
char const *  special 
)
inlinevirtual

Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.

Parameters
tkA reference to the BStreamFileToolkit object.
keyAn identifier to the object (for example, the HOOPS key of a geometry item)
specialA string value of particular data
Returns
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

References BBaseOpcodeHandler::Interpret().


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