# TK_Color_By_Value

## Functions

| `TK_Color_By_Value`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `SetGeometry`
int | `GetGeometry`
void | `SetSpace`
int | `GetSpace`
void | `SetValue`
void | `SetValue`
float const * | `GetValue`

## Detailed Description

class `TK_Color_By_Value` : public BBaseOpcodeHandler

  Handles the TKE_Color_By_Value opcode.

  TK_Color_By_Value provides support for writing/reading the TKE_Color_By_Value opcode object to/from an HSF file.

  The HOOPS/3dGS scene-graph segments can have colors set by value (RGB, HSV, HIC, etc…)

  Subclassed by HTK_Color_By_Value

  Public Functions

  inline `TK_Color_By_Value`()

    constructor

  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.

  inline void `SetGeometry`(int m)

    Sets the mask value which indicates which types of geometry are affected by this color setting. Geometry types are specified by TKO_Geometry_Bits.

  inline int `GetGeometry`() const

    Returns the mask value which indicates which types of geometry are affected by this color setting. Geometry types are specified by TKO_Geometry_Bits.

  inline void `SetSpace`(int s)

    Sets the type of color space used to interpret the values

  inline int `GetSpace`() const

    Returns the type of color space used to interpret the values

  inline void `SetValue`(float a, float b, float c)

    Sets the color value as discrete floats

  inline void `SetValue`(float const triple[])

    Sets the color value as a float triplet

  inline float const *`GetValue`() const

    Returns the color value as the address of a float triplet

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Visualize 3DF in your own language, or choose a sample question below to start a conversation:

What is HOOPS Visualize 3DF?
What are the latest release notes for HOOPS Visualize 3DF?
How do I start evaluating HOOPS Visualize 3DF?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...