TK_Rendering_Options
Functions
Detailed Description
-
class
TK_Rendering_Options: public BBaseOpcodeHandler 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.
Public Functions
-
TK_Rendering_Options() constructor
-
~TK_Rendering_Options()
-
virtual TK_Status
Read(BStreamFileToolkit &tk) 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.
-
virtual TK_Status
Write(BStreamFileToolkit &tk) 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.
-
virtual TK_Status
Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const 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.
-
TK_Status
ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
virtual void
Reset() 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.
-
inline void
SetMask(int m0, int m1 = 0, int m2 = 0) Sets the mask indicating which options have a setting
-
inline int
GetMask(int index = 0) const Returns the mask indicating which options have a setting
-
inline void
SetValue(int v0, int v1 = 0, int v2 = 0) Sets the mask indicating which options are set on/active
-
inline int
GetValue(int index = 0) const Returns the mask indicating which options are set on/active
-
inline void
SetHSR(int h) Sets the Hidden Surface Removal algorithm
-
inline int
GetHSR() const Returns the Hidden Surface Removal algorithm
-
inline void
SetTransparentHSR(int t) Sets the drawing style used for transparent components
-
inline int
GetTransparentHSR() const Returns the drawing style used for transparent components
-
inline void
SetTransparentStyle(int s) Sets the Hidden Surface Removal algorithm used for transparent components
-
inline int
GetTransparentStyle() const Returns the Hidden Surface Removal algorithm used for transparent components
-
inline void
SetTechnology(int t) Sets the general technology used for drawing
-
inline int
GetTechnology() const Returns the general technology used for drawing
-
inline void
SetQuantization(int q) Sets the quantization methods used when displaying on color-limited devices
-
inline int
GetQuantization() const Returns the quantization methods used when displaying on color-limited devices
-
inline void
SetDebug(int d) Sets the debug options
-
inline int
GetDebug() const Returns the debug options
-
inline void
SetFaceDisplacement(int d) Sets the face displacement value
-
inline int
GetFaceDisplacement() const Returns the face displacement value
-
inline void
SetVertexDisplacement(int d) Sets the vertex displacement value
-
inline int
GetVertexDisplacement() const Returns the vertex displacement value
-
inline void
SetGeneralDisplacement(int d) Sets the general displacement value
-
inline int
GetGeneralDisplacement() const Returns the general displacement value
-
inline void
SetJoinCutoffAngle(int d) Sets the join cutoff limit value
-
inline int
GetJoinCutoffAngle() const Returns the join cutoff limit value
-
inline void
SetFogLimits(float n, float f) Sets the fog limits using discrete values
-
inline void
SetFogLimits(float const l[]) Sets the fog limits using a float pair
-
inline float const *
GetFogLimits() const Returns the fog limits as the address of a float pair
-
inline void
SetLockMask(int m) Sets the mask indicating which attributes have a lock setting. Lock settings are specified by TKO_Attribute_Lock_Bits.
-
inline int
GetLockMask() const Returns the mask indicating which attributes have a lock setting. Lock settings are specified by TKO_Attribute_Lock_Bits.
-
inline void
SetLockValue(int v) Sets the mask indicating which attributes are locked. Lock settings are specified by TKO_Attribute_Lock_Bits.
-
inline int
GetLockValue() const Returns the mask indicating which attributes are locked. Lock settings are specified by TKO_Attribute_Lock_Bits.
-
inline void
SetVisibilityLockMask(int m) Sets the mask indicating which types of geometry have a visibility lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetVisibilityLockMask() const Returns the mask indicating which types of geometry have a visibility lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetVisibilityLockValue(int v) Sets the mask indicating which geometry visibilities are locked. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetVisibilityLockValue() const Returns the mask indicating which geometry visibilities are locked. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetColorLockMask(int m) Sets the mask indicating which types of geometry have a color lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetColorLockMask() const Returns the mask indicating which types of geometry have a color lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetColorLockValue(int v) Sets the mask indicating which geometry colors are locked. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetColorLockValue() const Returns the mask indicating which geometry colors are locked. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetColorFaceLockMask(int m) Sets the mask indicating which face color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorFaceLockMask() const Returns the mask indicating which face color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorFaceLockValue(int v) Sets the value indicating which face color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorFaceLockValue() const Returns the value indicating which face color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorEdgeLockMask(int m) Sets the mask indicating which edge color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorEdgeLockMask() const Returns the mask indicating which edge color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorEdgeLockValue(int v) Sets the value indicating which edge color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorEdgeLockValue() const Returns the value indicating which edge color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorLineLockMask(int m) Sets the mask indicating which line color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorLineLockMask() const Returns the mask indicating which line color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorLineLockValue(int v) Sets the value indicating which line color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorLineLockValue() const Returns the value indicating which line color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorMarkerLockMask(int m) Sets the mask indicating which marker color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorMarkerLockMask() const Returns the mask indicating which marker color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorMarkerLockValue(int v) Sets the value indicating which marker color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorMarkerLockValue() const Returns the value indicating which marker color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorTextLockMask(int m) Sets the mask indicating which text color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorTextLockMask() const Returns the mask indicating which text color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorTextLockValue(int v) Sets the value indicating which text color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorTextLockValue() const Returns the value indicating which text color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorWindowLockMask(int m) Sets the mask indicating which window color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorWindowLockMask() const Returns the mask indicating which window color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorWindowLockValue(int v) Sets the value indicating which window color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorWindowLockValue() const Returns the value indicating which window color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorFaceContrastLockMask(int m) Sets the mask indicating which face_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorFaceContrastLockMask() const Returns the mask indicating which face_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorFaceContrastLockValue(int v) Sets the value indicating which face_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorFaceContrastLockValue() const Returns the value indicating which face_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorWindowContrastLockMask(int m) Sets the mask indicating which window_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorWindowContrastLockMask() const Returns the mask indicating which window_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorWindowContrastLockValue(int v) Sets the value indicating which window_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorWindowContrastLockValue() const Returns the value indicating which window_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorBackLockMask(int m) Sets the mask indicating which back color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorBackLockMask() const Returns the mask indicating which back color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorBackLockValue(int v) Sets the value indicating which back color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorBackLockValue() const Returns the value indicating which back color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorVertexLockMask(int m) Sets the mask indicating which vertex color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorVertexLockMask() const Returns the mask indicating which vertex color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorVertexLockValue(int v) Sets the value indicating which vertex color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorVertexLockValue() const Returns the value indicating which vertex color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorEdgeContrastLockMask(int m) Sets the mask indicating which edge_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorEdgeContrastLockMask() const Returns the mask indicating which edge_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorEdgeContrastLockValue(int v) Sets the value indicating which edge_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorEdgeContrastLockValue() const Returns the value indicating which edge_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorLineContrastLockMask(int m) Sets the mask indicating which line_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorLineContrastLockMask() const Returns the mask indicating which line_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorLineContrastLockValue(int v) Sets the value indicating which line_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorLineContrastLockValue() const Returns the value indicating which line_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorMarkerContrastLockMask(int m) Sets the mask indicating which marker_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorMarkerContrastLockMask() const Returns the mask indicating which marker_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorMarkerContrastLockValue(int v) Sets the value indicating which marker_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorMarkerContrastLockValue() const Returns the value indicating which marker_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorVertexContrastLockMask(int m) Sets the mask indicating which vertex_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorVertexContrastLockMask() const Returns the mask indicating which vertex_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorVertexContrastLockValue(int v) Sets the value indicating which vertex_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorVertexContrastLockValue() const Returns the value indicating which vertex_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorTextContrastLockMask(int m) Sets the mask indicating which text_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorTextContrastLockMask() const Returns the mask indicating which text_contrast color channels have a lock setting. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetColorTextContrastLockValue(int v) Sets the value indicating which text_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline int
GetColorTextContrastLockValue() const Returns the value indicating which text_contrast color channels are locked. Color channels are specified by TKO_Color_Channel_Lock_Bits.
-
inline void
SetForcedLockMask(int m) Sets the mask indicating which attributes have a forced lock setting. ForcedLock settings are specified by #TKO_Attribute_ForcedLock_Bits.
-
inline int
GetForcedLockMask() const Returns the mask indicating which attributes have a forced lock setting. ForcedLock settings are specified by #TKO_Attribute_ForcedLock_Bits.
-
inline void
SetForcedLockValue(int v) Sets the mask indicating which attributes are forceded. ForcedLock settings are specified by #TKO_Attribute_ForcedLock_Bits.
-
inline int
GetForcedLockValue() const Returns the mask indicating which attributes are forceded. ForcedLock settings are specified by #TKO_Attribute_ForcedLock_Bits.
-
inline void
SetVisibilityForcedLockMask(int m) Sets the mask indicating which types of geometry have a visibility forced lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetVisibilityForcedLockMask() const Returns the mask indicating which types of geometry have a visibility forced lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetVisibilityForcedLockValue(int v) Sets the mask indicating which geometry visibilities are forceded. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetVisibilityForcedLockValue() const Returns the mask indicating which geometry visibilities are forceded. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetColorForcedLockMask(int m) Sets the mask indicating which types of geometry have a color forced lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetColorForcedLockMask() const Returns the mask indicating which types of geometry have a color forced lock setting. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetColorForcedLockValue(int v) Sets the mask indicating which geometry colors are forceded. Geometry types are specified by TKO_Geometry_Bits.
-
inline int
GetColorForcedLockValue() const Returns the mask indicating which geometry colors are forceded. Geometry types are specified by TKO_Geometry_Bits.
-
inline void
SetColorFaceForcedLockMask(int m) Sets the mask indicating which face color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorFaceForcedLockMask() const Returns the mask indicating which face color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorFaceForcedLockValue(int v) Sets the value indicating which face color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorFaceForcedLockValue() const Returns the value indicating which face color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorEdgeForcedLockMask(int m) Sets the mask indicating which edge color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorEdgeForcedLockMask() const Returns the mask indicating which edge color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorEdgeForcedLockValue(int v) Sets the value indicating which edge color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorEdgeForcedLockValue() const Returns the value indicating which edge color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorLineForcedLockMask(int m) Sets the mask indicating which line color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorLineForcedLockMask() const Returns the mask indicating which line color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorLineForcedLockValue(int v) Sets the value indicating which line color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorLineForcedLockValue() const Returns the value indicating which line color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorMarkerForcedLockMask(int m) Sets the mask indicating which marker color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorMarkerForcedLockMask() const Returns the mask indicating which marker color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorMarkerForcedLockValue(int v) Sets the value indicating which marker color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorMarkerForcedLockValue() const Returns the value indicating which marker color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorTextForcedLockMask(int m) Sets the mask indicating which text color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorTextForcedLockMask() const Returns the mask indicating which text color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorTextForcedLockValue(int v) Sets the value indicating which text color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorTextForcedLockValue() const Returns the value indicating which text color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorWindowForcedLockMask(int m) Sets the mask indicating which window color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorWindowForcedLockMask() const Returns the mask indicating which window color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorWindowForcedLockValue(int v) Sets the value indicating which window color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorWindowForcedLockValue() const Returns the value indicating which window color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorFaceContrastForcedLockMask(int m) Sets the mask indicating which face_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorFaceContrastForcedLockMask() const Returns the mask indicating which face_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorFaceContrastForcedLockValue(int v) Sets the value indicating which face_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorFaceContrastForcedLockValue() const Returns the value indicating which face_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorWindowContrastForcedLockMask(int m) Sets the mask indicating which window_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorWindowContrastForcedLockMask() const Returns the mask indicating which window_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorWindowContrastForcedLockValue(int v) Sets the value indicating which window_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorWindowContrastForcedLockValue() const Returns the value indicating which window_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorBackForcedLockMask(int m) Sets the mask indicating which back color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorBackForcedLockMask() const Returns the mask indicating which back color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorBackForcedLockValue(int v) Sets the value indicating which back color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorBackForcedLockValue() const Returns the value indicating which back color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorVertexForcedLockMask(int m) Sets the mask indicating which vertex color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorVertexForcedLockMask() const Returns the mask indicating which vertex color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorVertexForcedLockValue(int v) Sets the value indicating which vertex color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorVertexForcedLockValue() const Returns the value indicating which vertex color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorEdgeContrastForcedLockMask(int m) Sets the mask indicating which edge_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorEdgeContrastForcedLockMask() const Returns the mask indicating which edge_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorEdgeContrastForcedLockValue(int v) Sets the value indicating which edge_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorEdgeContrastForcedLockValue() const Returns the value indicating which edge_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorLineContrastForcedLockMask(int m) Sets the mask indicating which line_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorLineContrastForcedLockMask() const Returns the mask indicating which line_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorLineContrastForcedLockValue(int v) Sets the value indicating which line_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorLineContrastForcedLockValue() const Returns the value indicating which line_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorMarkerContrastForcedLockMask(int m) Sets the mask indicating which marker_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorMarkerContrastForcedLockMask() const Returns the mask indicating which marker_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorMarkerContrastForcedLockValue(int v) Sets the value indicating which marker_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorMarkerContrastForcedLockValue() const Returns the value indicating which marker_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorVertexContrastForcedLockMask(int m) Sets the mask indicating which vertex_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorVertexContrastForcedLockMask() const Returns the mask indicating which vertex_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorVertexContrastForcedLockValue(int v) Sets the value indicating which vertex_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorVertexContrastForcedLockValue() const Returns the value indicating which vertex_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorTextContrastForcedLockMask(int m) Sets the mask indicating which text_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorTextContrastForcedLockMask() const Returns the mask indicating which text_contrast color channels have a forced lock setting. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetColorTextContrastForcedLockValue(int v) Sets the value indicating which text_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline int
GetColorTextContrastForcedLockValue() const Returns the value indicating which text_contrast color channels are forceded. Color channels are specified by #TKO_Color_Channel_ForcedLock_Bits.
-
inline void
SetBufferOptionsMask(int v) Sets the mask indicating which buffer options are set.
-
inline int
GetBufferOptionsMask() const Returns the mask indicating which buffer options are set.
-
inline void
SetBufferOptionsValue(int v) Sets the mask indicating which buffer options are “on”.
-
inline int
GetBufferOptionsValue() const Returns the mask indicating which buffer options are “on”.
-
inline void
SetBufferSizeLimit(int l) Sets the size limit on the software frame buffer.
-
inline int
GetBufferSizeLimit() const Returns the size limit on the software frame buffer.
-
inline void
SetStereoSeparation(float s) Sets the eye separation for stereo viewing.
-
inline float
GetStereoSeparation() const Returns the eye separation for stereo viewing.
-
inline void
SetStereoDistance(float d) Sets the focal distance for stereo viewing.
-
inline float
GetStereoDistance() const Returns the focal distance for stereo viewing.
-
inline void
SetHlrOptions(int o) Sets the mask indicating which hlr options are set.
-
inline int
GetHlrOptions() const Returns the mask indicating which hlr options are set.
-
inline void
SetHlrDimFactor(float d) Sets the dim factor used when hidden lines are displayed.
-
inline float
GetHlrDimFactor() const Returns the dim factor used when hidden lines are displayed.
-
inline void
SetHlrFaceDisplacement(float d) Sets the displacement used for faces during hidden line calculations.
-
inline float
GetHlrFaceDisplacement() const Returns the displacement used for faces during hidden line calculations.
-
inline void
SetHlrLinePattern(int p) Sets the mask indicating which hlr options are set.
-
inline int
GetHlrLinePattern() const Returns the mask indicating which hlr options are set.
-
inline void
SetHlrFaceSortingAlgorithm(int a) Sets the displacement used for faces during hidden line calculations.
-
inline float
GetHlrFaceSortingAlgorithm() const Returns the displacement used for faces during hidden line calculations.
-
inline void
SetNURBSOptionsMask(int m) Sets the mask indicating which NURBS options are set.
-
inline int
GetNURBSOptionsMask() const Returns the mask indicating which NURBS options are set.
-
inline void
SetNURBSOptionsValue(int v) Sets the mask indicating which NURBS options are “on”.
-
inline int
GetNURBSOptionsValue() const Returns the mask indicating which NURBS options are “on”.
-
inline void
SetNURBSCurveBudget(int b) Sets the point budget for NURBS curve tessellation.
-
inline int
GetNURBSCurveBudget() const Returns the point budget for NURBS curve tessellation.
-
inline void
SetNURBSCurveContinuedBudget(int b) Sets the point budget for NURBS curve tessellation.
-
inline int
GetNURBSCurveContinuedBudget() const Returns the point budget for NURBS curve tessellation.
-
inline void
SetNURBSSurfaceBudget(int b) Sets the point budget for NURBS surface tessellation.
-
inline int
GetNURBSSurfaceBudget() const Returns the point budget for NURBS surface tessellation.
-
inline void
SetNURBSSurfaceTrimBudget(int b) Sets the point budget for NURBS trim curve tessellation.
-
inline int
GetNURBSSurfaceTrimBudget() const Returns the point budget for NURBS trim curve tessellation.
-
inline void
SetLodOptionsMask(int v) Sets the mask indicating which LOD options are set.
-
inline int
GetLodOptionsMask() const Returns the mask indicating which LOD options are set.
-
inline void
SetLodOptionsValue(int v) Sets the mask indicating which LOD options are “on”.
-
inline int
GetLodOptionsValue() const Returns the mask indicating which LOD options are “on”.
-
inline void
SetLodAlgorithm(int v) Sets the type of algorithm used for LOD generation
-
inline int
GetLodAlgorithm() const Returns the type of algorithm used for LOD generation
-
inline void
SetLodMinimumTriangleCount(int v) Sets the minimum triangle count for LOD generation
-
inline int
GetLodMinimumTriangleCount() const Returns the minimum triangle count for LOD generation
-
inline void
SetLodNumLevels(int v) Sets the number of LOD levels to generate
-
inline int
GetLodNumLevels() const Returns the number of LOD levels to generate
-
inline void
SetLodClamp(int v) Sets the clamp level for LOD display
-
inline int
GetLodClamp() const Returns the clamp level for LOD display
-
inline void
SetLodMaxDegree(int v) Sets the maximum degree
-
inline int
GetLodMaxDegree() const Returns the maximum degree
-
inline void
SetLodTolerance(float v) Sets the tolerance for collapsing points
-
inline float
GetLodTolerance() const Returns the tolerance for collapsing points
-
inline void
SetLodFallback(int v) Sets the fallback method for LOD display selection
-
inline int
GetLodFallback() const Returns the fallback method for LOD display selection
-
inline void
SetLodBounding(float x1, float y1, float z1, float x2, float y2, float z2) Sets the explicit LOD bounding volume as discrete float values
-
inline void
SetLodBounding(float const s[], float const e[]) Sets the explicit LOD bounding volume using discrete float triplets
-
inline void
SetLodBounding(float const p[]) Sets the explicit LOD bounding volume using an array of 6 floats
-
inline float const *
GetLodBounding() const Returns the explicit LOD bounding volume as the address of an array of six floats
-
inline void
SetLodRatio(float r) Sets a single ratio used for LOD generation
-
inline void
SetLodRatios(int c, float const r[] = 0) Sets the ratios used for LOD generation
-
inline int
GetLodNumRatios() const Returns the count of ratios used for LOD generation
-
inline float const *
GetLodRatios() const Returns the ratios used for LOD generation
-
inline float *
GetLodRatios() Returns the ratios used for LOD generation as the address of a buffer which may be modified
-
inline void
SetLodThresholdType(int v) Sets the method used to determine when a LOD is not worth generating
-
inline int
GetLodThresholdType() const Returns the method used to determine when a LOD is not worth generating
-
inline void
SetLodThreshold(float r) Sets a single threshold used for LOD generation
-
inline void
SetLodThresholds(int c, float const r[] = 0) Sets the thresholds used for LOD generation
-
inline int
GetLodNumThresholds() const Returns the count of thresholds used for LOD generation
-
inline float const *
GetLodThresholds() const Returns the thresholds used for LOD generation
-
inline float *
GetLodThresholds() Returns the thresholds used for LOD generation as the address of a buffer which may be modified
-
inline void
SetLodCutoff(float r) Sets a single cutoff used for LOD generation
-
inline void
SetLodCutoffs(int c, float const r[] = 0) Sets the cutoffs used for LOD generation
-
inline int
GetLodNumCutoffs() const Returns the count of cutoffs used for LOD generation
-
inline float const *
GetLodCutoffs() const Returns the cutoffs used for LOD generation
-
inline float *
GetLodCutoffs() Returns the cutoffs used for LOD generation as the address of a buffer which may be modified
-
inline void
SetTessellationMask(int m) Sets the mask indicating which tessellation options are set.
-
inline int
GetTessellationMask() const Returns the mask indicating which tessellation options are set.
-
inline void
SetCylinderTessellation(int n) Sets a single cylinder tessellation value used for surface generation
-
inline void
SetCylinderTessellations(int c, char const *n = 0) Sets the cylinder tessellation values used for surface generation
-
inline int
GetNumCylinderTessellations() const Returns the count of cylinder tessellation values used for surface generation
-
inline char const *
GetCylinderTessellations() const Returns the cylinder tessellation values used for surface generation
-
inline char *
GetCylinderTessellations() Returns the cylinder tessellation values for surface generation as the address of a buffer which may be modified
-
inline void
SetSphereTessellation(int n) Sets a single sphere tessellation value used for surface generation
-
inline void
SetSphereTessellations(int c, char const *n = 0) Sets the sphere tessellation values used for surface generation
-
inline int
GetNumSphereTessellations() const Returns the count of sphere tessellation values used for surface generation
-
inline char const *
GetSphereTessellations() const Returns the sphere tessellation values used for surface generation
-
inline char *
GetSphereTessellations() Returns the sphere tessellation values for surface generation as the address of a buffer which may be modified
-
inline void
SetGeometryOptionsMask(int m) Sets the mask indicating which geometry options are set.
-
inline int
GetGeometryOptionsMask() const Returns the mask indicating which geometry options are set.
-
inline void
SetHardEdgeAngle(int m) Sets the value of the hard edge angle limit.
-
inline float
GetHardEdgeAngle() const Returns the hard edge angle limit.
-
inline void
SetMaskTransform(int m) Sets the mask indicating which transform components should be blocked.
-
inline int
GetMaskTransform() const Returns the mask indicating which transform components should be blocked.
-
inline void
SetCutGeometry(int m) Sets the mask indicating which cut geometry options to use.
-
inline int
GetCutGeometry() const Returns the mask indicating which cut geometry options are set.
-
inline void
SetCutGeometryLevel(int m) Sets the cut geometry level.
-
inline int
GetCutGeometryLevel() const Returns the geometry level.
-
inline void
SetCutGeometryColorMatch(int m) Sets the cut geometry color match option.
-
inline int
GetCutGeometryColorMatch() const Returns the cut geometry color match option.
-
inline void
SetCutGeometryUsage(int u) Sets the cut geometry usage option.
-
inline int
GetCutGeometryUsage() const Returns the cut geometry usage option.
-
inline void
SetCutGeometryTolerance(float m) Sets the cut geometry point matching tolerance.
-
inline float
GetCutGeometryTolerance() const Returns the cut geometry point matching tolerance.
-
inline void
SetCutGeometryEdgeWeight(float value, int units = TKO_Generic_Size_Unspecified) Sets the size value & units (value may not be negative, units only meaningful if positive)
-
inline float
GetCutGeometryEdgeWeight() const Returns the size value
-
inline int
GetCutGeometryEdgeWeightUnits() const Returns the size value
-
void
SetCutGeometryEdgePattern(char const *pattern) Sets the cut geometry edge pattern. Allocates the buffer and copies the string
-
void
SetCutGeometryEdgePattern(int length) Sets the cut geometry edge pattern buffer. Allocates a buffer large enough to hold a string of ‘length’ bytes
-
inline char const *
GetCutGeometryEdgePattern() const Returns the cut geometry edge pattern
-
inline char *
GetCutGeometryEdgePattern() Returns the cut geometry edge pattern buffer, which may be modified directly
-
inline void
SetDisplayListLevel(int m) Sets the display list level.
-
inline int
GetDisplayListLevel() const Returns the display list level.
-
inline void
SetSimpleShadow(int m) Sets the mask indicating which simple shadow options to use.
-
inline int
GetSimpleShadow() const Returns the mask indicating which simple shadow options are set.
-
inline void
SetSimpleShadowBlur(int m) Sets the simple shadow blur (softness) level.
-
inline int
GetSimpleShadowBlur() const Returns simple shadow blur (softness) level.
-
inline void
SetSimpleShadowResolution(int m) Sets the simple shadow image resolution.
-
inline int
GetSimpleShadowResolution() const Returns simple shadow image resolution.
-
inline void
SetSimpleShadowLight(float x, float y, float z) Sets the simple shadow light direction using discrete values
-
inline void
SetSimpleShadowLight(float const l[]) Sets the simple shadow light direction using a float pair
-
inline float const *
getSimpleShadowLight() const Returns the simple shadow light direction as the address of a float array
-
inline void
SetSimpleShadowPlane(float a, float b, float c, float d) Sets the simple shadow projection plane using discrete values
-
inline void
SetSimpleShadowPlane(float const p[]) Sets the simple shadow projection plane using a float pair
-
inline float const *
GetSimpleShadowPlane() const Returns the simple shadow projection plane as the address of a float array
-
inline void
SetSimpleShadowColor(float r, float g, float b) Sets the rgb color value as discrete floats
-
inline void
SetSimpleShadowColor(float const rgb[]) Sets the rgb color value as a float triplet
-
inline float const *
GetSimpleShadowColor() const Returns the rgb color value as the address of a float triplet
-
inline void
SetSimpleShadowOpacity(float o) Sets the simple shadow opacity.
-
inline float
GetSimpleShadowOpacity() const Returns simple shadow opacity.
-
inline void
SetShadowMap(int m) Sets the mask indicating which shadow map options to use.
-
inline int
GetShadowMap() const Returns the mask indicating which shadow map options are set.
-
inline void
SetShadowMapResolution(int m) Sets the shadow map image resolution.
-
inline int
GetShadowMapResolution() const Returns shadow map image resolution.
-
inline void
SetShadowMapSamples(int m) Sets the shadow map image samples.
-
inline int
GetShadowMapSamples() const Returns shadow map image resolution.
-
inline void
SetSimpleReflection(int m) Sets the mask indicating which simple reflection options to use.
-
inline int
GetSimpleReflection() const Returns the mask indicating which simple reflection options are set.
-
inline void
SetSimpleReflectionPlane(float a, float b, float c, float d) Sets the simple reflection projection plane using discrete values
-
inline void
SetSimpleReflectionPlane(float const p[]) Sets the simple reflection projection plane using a float pair
-
inline float const *
GetSimpleReflectionPlane() const Returns the simple reflection projection plane as the address of a float array
-
inline void
SetSimpleReflectionOpacity(float o) Sets the simple reflection opacity.
-
inline float
GetSimpleReflectionOpacity() const Returns simple reflection opacity.
-
inline void
SetSimpleReflectionVisibilityMask(int m) Sets the mask indicating which simple reflection options to use.
-
inline int
GetSimpleReflectionVisibilityValue() const Returns the mask indicating which simple reflection options are set.
-
inline void
SetDepthRange(float n, float f) Sets the depth range using discrete values
-
inline void
SetDepthRange(float const l[]) Sets the depth range using a float pair
-
inline float const *
GetDepthRange() const Returns the depth range as the address of a float pair
-
inline void
SetScreenRange(float l, float r, float b, float t, float lo = 0, float ro = 0, float bo = 0, float to = 0) Sets the screen range using discrete values
-
inline void
SetScreenRange(float const l[]) Sets the screen range using a float array (assumed 4 long)
-
inline void
SetScreenRange(float const l[], float const o[]) Sets the screen range using two float arrays (each assumed 4 long)
-
inline void
SetScreenRange(int n, float const l[]) Sets the screen range using a float array (specified length, should be 4 or 8)
-
inline float const *
GetScreenRange() const Returns the screen range as the address of a float pair
-
inline void
SetAmbientUpVector(float x, float y, float z) Sets the ambient up vector. HOOPS can color shift ambient light between 2 colors based on world-space normals. Graphics systems that are unable to do this may choose to instead use the average of the two values as their ambient term. See TK_Color.
-
inline void
SetAmbientUpVector(float const v[]) Sets the ambient up vector using a float array
-
inline float const *
GetAmbientUpVector() const Returns the ambient up vector as the address to a float array
-
inline void
SetImageScale(float x, float y) Sets the image scale factors using discrete values
-
inline void
SetImageScale(float const s[]) Sets the image scale factors using a float pair
-
inline float const *
GetImageScale() const Returns the image scale factors as the address of a float pair
-
inline void
SetImageTintColor(float r, float g, float b) Sets the rgb color value as discrete floats
-
inline void
SetImageTintColor(float const rgb[]) Sets the rgb color value as a float triplet
-
inline float const *
GetImageTintColor() const Returns the rgb color value as the address of a float triplet
-
inline void
SetDiffuseTextureTintColor(float r, float g, float b) Sets the rgb color value as discrete floats
-
inline void
SetDiffuseTextureTintColor(float const rgb[]) Sets the rgb color value as a float triplet
-
inline float const *
GetDiffuseTextureTintColor() const Returns the rgb color value as the address of a float triplet
-
inline void
SetAntiAlias(int m) Sets the mask indicating which anti-aliasing options to use.
-
inline int
GetAntiAlias() const Returns the mask indicating which anti-aliasing options are set.
-
inline void
SetVertexDecimation(float f) Sets the vertex decimation factor.
-
inline float
GetVertexDecimation() const Returns the vertex decimation factor.
-
