IParamList class

<oceansdk/parameters.h>

Description

This class allows plugin nodes to expose their parameters to Ocean

Namespace

This class is in the namespace Ocean::Sdk

Members

class IParamList
void addReal(const char *name, float value, float min, float max)

[virtual]

Parameters
  • name – Parameter name as a null terminated string

  • value – Default parameter value

  • min – Minimum parameter value

  • max – Maximum parameter value

Adds a real number parameter.

The parameter name must contain only lowercase ASCII letters (a-z), underscores (_) and digits (0-9).

void addBool(const char *name, bool value)

[virtual]

Parameters
  • name – Parameter name as a null terminated string

  • value – Default parameter value

Adds a boolean parameter.

The parameter name must contain only lowercase ASCII letters (a-z), underscores (_) and digits (0-9).

void addVector(const char *name, const Vec3<float> &value)

[virtual]

Parameters
  • name – Parameter name as a null terminated string

  • value – Default parameter value

Adds a 3D vector parameter

The parameter name must contain only lowercase ASCII letters (a-z), underscores (_) and digits (0-9).

void addUnitVector(const char *name, const Vec3<float> &value)

[virtual]

Parameters
  • name – Parameter name as a null terminated string

  • value – Default parameter value

Adds a normalized 3D vector parameter

The parameter name must contain only lowercase ASCII letters (a-z), underscores (_) and digits (0-9).

~IParamList()

[virtual]

The destructor for IParamList