TK_PBR
-
class
TK_PBR Handles the TKE_PBR opcode.
TK_Colorprovides support for writing/reading the TKE_PBR opcode object to/from an HSF file.The HOOPS/3dGS scene-graph segments can have a Physically Based Rendering material definition
Inherits from:
BBaseOpcodeHandlerIndex
Methods
Clone()GetAlphaFactor()GetBaseColorFactor()GetBaseColorMap()GetBaseColorMap()GetEmissiveMap()GetEmissiveMap()GetMetalnessFactor()GetMetalnessMap()GetMetalnessMap()GetMetalnessMapChannel()GetNormalFactor()GetNormalMap()GetNormalMap()GetOcclusionFactor()GetOcclusionMap()GetOcclusionMap()GetOcclusionMapChannel()GetOptions()GetRoughnessFactor()GetRoughnessMap()GetRoughnessMap()GetRoughnessMapChannel()Read()ReadAscii()Reset()reset_string()set_string()set_string()SetAlphaFactor()SetBaseColorFactor()SetBaseColorFactor()SetBaseColorMap()SetBaseColorMap()SetEmissiveMap()SetEmissiveMap()SetMetalnessFactor()SetMetalnessMap()SetMetalnessMap()SetMetalnessMapChannel()SetNormalFactor()SetNormalMap()SetNormalMap()SetOcclusionFactor()SetOcclusionMap()SetOcclusionMap()SetOcclusionMapChannel()SetOptions()SetRoughnessFactor()SetRoughnessMap()SetRoughnessMap()SetRoughnessMapChannel()TK_PBR()Write()WriteAscii()~TK_PBR()
Variables
Methods
-
TK_Status
TK_PBR::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_PBR::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_PBR::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_PBR::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_PBR::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_PBR::Reset() 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.
-
void
TK_PBR::SetOptions(int m) Sets the options flags. Option types are specified by TKO_PBR_Options.
-
int
TK_PBR::GetOptions() const const
Returns the options flags. Option types are specified by TKO_PBR_Options.
-
void
TK_PBR::SetBaseColorMap(char const *name) Sets the base color map as a string value. Allocates the buffer and copies the string
-
void
TK_PBR::SetBaseColorMap(int length) Sets the base color map string buffer. Allocates a buffer to hold a string of ‘length’ characters
-
char const *
TK_PBR::GetBaseColorMap() const const
Returns the address of the base color map string.
-
char *
TK_PBR::GetBaseColorMap() Returns the address of the base color map buffer, which may be modified directly.
-
void
TK_PBR::SetNormalMap(char const *name) Sets the normal map as a string value. Allocates the buffer and copies the string
-
void
TK_PBR::SetNormalMap(int length) Sets the normal map string buffer. Allocates a buffer to hold a string of ‘length’ characters
-
char *
TK_PBR::GetNormalMap() Returns the address of the normal map buffer, which may be modified directly.
-
void
TK_PBR::SetEmissiveMap(char const *name) Sets the emissive map as a string value. Allocates the buffer and copies the string
-
void
TK_PBR::SetEmissiveMap(int length) Sets the emissive map string buffer. Allocates a buffer to hold a string of ‘length’ characters
-
char *
TK_PBR::GetEmissiveMap() Returns the address of the emissive map buffer, which may be modified directly.
-
void
TK_PBR::SetMetalnessMap(char const *name) Sets the metalness map as a string value. Allocates the buffer and copies the string
-
void
TK_PBR::SetMetalnessMap(int length) Sets the metalness map string buffer. Allocates a buffer to hold a string of ‘length’ characters
-
char *
TK_PBR::GetMetalnessMap() Returns the address of the metalness map buffer, which may be modified directly.
-
void
TK_PBR::SetRoughnessMap(char const *name) Sets the roughness map as a string value. Allocates the buffer and copies the string
-
void
TK_PBR::SetRoughnessMap(int length) Sets the roughness map string buffer. Allocates a buffer to hold a string of ‘length’ characters
-
char *
TK_PBR::GetRoughnessMap() Returns the address of the roughness map buffer, which may be modified directly.
-
void
TK_PBR::SetOcclusionMap(char const *name) Sets the occlusion map as a string value. Allocates the buffer and copies the string
-
void
TK_PBR::SetOcclusionMap(int length) Sets the occlusion map string buffer. Allocates a buffer to hold a string of ‘length’ characters
-
char *
TK_PBR::GetOcclusionMap() Returns the address of the occlusion map buffer, which may be modified directly.
-
void
TK_PBR::SetBaseColorFactor(float r, float g, float b, float a) Sets the base color factor using discrete rgba values
-
float const *
TK_PBR::GetBaseColorFactor() const const
Returns the base color factor as the address of a float quad
Variables