VRay SDK for C#
Loading...
Searching...
No Matches
VRay.BinUserAttributesWriter Class Reference

Attributes storage format: [attrName\0|type{uint8}|value{some_bytes}][...][...]\0 More...

Public Member Functions

void Add (string name, AColor value)
 Append color attribute. More...
 
void Add (string name, float value)
 Append float attribute. More...
 
void Add (string name, int value)
 Append integer attribute. More...
 
void Add (string name, string value)
 Append string attribute. More...
 
void Add (string name, Vector value)
 Append vector attribute. More...
 
void Close ()
 Finalize attributes per instance. Call Close() to separate attributes between different instances.
 
int GetNumBytes ()
 Get number of written bytes. More...
 
IList< int > ToIntList ()
 Get binary serialized data as IntList for easier assignment as plugin property value. This will reset the state of BinUserAttributesWriter! /summary>

Returns
The binary serialized data as IntList with appended 0 at the end.

 
override string ToString ()
 Returns the hex string representation that is written to the returned IntList including the final 0 character. More...
 

Detailed Description

Attributes storage format: [attrName\0|type{uint8}|value{some_bytes}][...][...]\0

Member Function Documentation

◆ Add() [1/5]

void VRay.BinUserAttributesWriter.Add ( string  name,
AColor  value 
)

Append color attribute.

Parameters
nameAttribute name.
valueAColor value.

◆ Add() [2/5]

void VRay.BinUserAttributesWriter.Add ( string  name,
float  value 
)

Append float attribute.

Parameters
nameAttribute name.
valueFloating point value.

◆ Add() [3/5]

void VRay.BinUserAttributesWriter.Add ( string  name,
int  value 
)

Append integer attribute.

Parameters
nameAttribute name.
valueInteger value.

◆ Add() [4/5]

void VRay.BinUserAttributesWriter.Add ( string  name,
string  value 
)

Append string attribute.

Parameters
nameAttribute name.
valueString value.

◆ Add() [5/5]

void VRay.BinUserAttributesWriter.Add ( string  name,
Vector  value 
)

Append vector attribute.

Parameters
nameAttribute name.
valueVector value.

◆ GetNumBytes()

int VRay.BinUserAttributesWriter.GetNumBytes ( )

Get number of written bytes.

Returns
Number of written bytes without the final 0 at the end.

◆ ToString()

override string VRay.BinUserAttributesWriter.ToString ( )

Returns the hex string representation that is written to the returned IntList including the final 0 character.

Returns
Hex string.

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