# TK_Renumber

## Functions

| `TK_Renumber`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `SetKey`
long | `GetKey`

## Detailed Description

class `TK_Renumber` : public BBaseOpcodeHandler

  Handles the TKE_Renumber_Key_Global, TKE_Renumber_Key_Local, and TKE_Priority opcodes.

  TK_Renumber provides support for writing/reading the TKE_Renumber_Key_Global and TKE_Renumber_Key_Local opcode objects to/from an HSF file. This action operates on whatever entity was specified in the previous opcode.

  The HOOPS/3dGS scene-graph supports the concept of renumbered keys. (Keys can refer to either segments or geometric primitives.) HOOPS entities that do not have keys (e.g. rendering options and other attributes) may not be renumbered. HOOPS/3DGS segments may hav a priority value assigned which overrides the default alphabetic sorting.

  Public Functions

  inline `TK_Renumber`(unsigned char opcode, long key = 0)

    same as the default constructor in BBaseOpcodeHandler, except that a new key can optionally be provided directly at the time of construction

  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 `SetKey`(long k)

    Sets the key (identifier) value

  inline long `GetKey`() const

    Returns the key (identifier) value

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize 3DF 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...