cohtml.Net.Property

Represents a property of a type exposed to the scripting. This interface type-erases access to a native property so the SDK can interact with it without knowing its concrete C++ type. All virtual methods in this interface must be implemented by derived Property classes for data binding to function correctly. Conversion methods ( ToString , ToBool , ToNumber , etc.) are invoked by the SDK only when a conversion is actually required; not all properties are expected to support every conversion, and unsupported conversions should simply fail gracefully. The Bind and Read methods perform the actual data exchange with the script. When the SDK requires knowledge of the underlying native type for type-sensitive operations such as expression evaluation, it obtains it through BindValue() using a dummy binder that does not expose the value to the script.

Inherits from SystemIDisposable

Inherited by cohtml.Net.UnityProperty

Public Functions #

Protected Attributes #

Public Functions Documentation #

function Dispose #

virtual void Dispose()

Reimplemented by: cohtml.Net.UnityProperty.Dispose

function Property #

Property(
    string name,
    bool isByRef
)

function Property #

Property(
    string name
)

function GetName #

string GetName()

Get the name of the property.

Return: the name of the property

function IsByRef #

bool IsByRef()

Can this property be exported By-Ref. Temporaries can not be exported by reference.

Return: true if the property can be exported safely by reference.

function Bind #

virtual global.System.IntPtr Bind(
    System.IntPtr binder,
    global.System.IntPtr arg1
)

Expose the property’s name and value to a binder.

Parameters:

• binder - the binder to use

Return: - adjusted object pointer if necessary

function BindValue #

virtual global.System.IntPtr BindValue(
    System.IntPtr binder,
    global.System.IntPtr arg1
)

Expose only the value of the property to a binder.

Parameters:

• binder - the binder to use

Return: - adjusted object pointer if necessary

Note: This method should always bind a value. If there is no valid value, the implementation must call binder->BindNull();

function Read #

virtual global.System.IntPtr Read(
    System.IntPtr binder,
    global.System.IntPtr arg1
)

Read the value from a binder.

Parameters:

• binder - the binder to use

Return: - adjusted object pointer if necessary

function ReadValue #

virtual global.System.IntPtr ReadValue(
    System.IntPtr binder,
    global.System.IntPtr arg1
)

Read only the value of the property from a binder.

Parameters:

• binder - the binder to use

Return: - adjusted object pointer if necessary

function Clone #

virtual Property Clone()

Clone the property.

Return: a heap allocated copy of the property

function ToBoolean #

virtual bool ToBoolean(
    global.System.IntPtr arg0,
    System.IntPtr boolean
)

Convert the property value to a boolean.

Parameters:

• boolean - where to store the property value

Return: true if conversion is possible and successful

function ToNumber #

virtual bool ToNumber(
    global.System.IntPtr arg0,
    System.IntPtr number
)

Convert the property value to a number.

Parameters:

• number - where to store the property value

Return: true if conversion is possible and successful

function ToDouble #

virtual bool ToDouble(
    global.System.IntPtr arg0,
    System.IntPtr number
)

function ToString #

virtual bool ToString(
    global.System.IntPtr arg0,
    System.IntPtr buffer,
    System.IntPtr length
)

Convert the property value to a string representation.

Parameters:

• length - input/output parameter; on input, specifies the size of buffer in bytes; on output, receives the total size required to store the full string (not including any null terminator)

Return: true if conversion is possible and successful

Note: The function writes up to *length bytes into buffer. These may or may not include a null terminator. The caller should append \0'" if required. If the returned size is greater than the provided buffer capacity, the caller should allocate a larger buffer and call again.