IPrepareContext class

<oceansdk/contexts.h>

Description

This class allows plugin nodes to have child nodes.

Add functions declare the children to Ocean and must be called in the addChildren() overloads of plugin classes.

Get functions must be called in the prepare() overloads of plugin classes. The returned pointers should be stored for later use in main node functions.

Namespace

This class is in the namespace Ocean::Sdk

Members

class IPrepareContext
float wavelengthMin() const

[virtual]

Returns

The lower bound of the simulated wavelength range in meters

float wavelengthMax() const

[virtual]

Returns

The upper bound of the simulated wavelength range in meters

const IEnvironment *getEnvironmentChild(const char *childName) const

[virtual]

Parameters

childName – Child name as a null terminated string

Returns

Valid pointer to the child node if successful, null pointer otherwise

Retrieves a pointer to the environment child with the corresponding name. If no corresponding child is found, either because it has never been declared with addEnvironment() or if the child is optional and disabled by the user, the function returns a null pointer.

const IEnvironment *getFilterShaderChild(const char *childName) const

[virtual]

Parameters

childName – Child name as a null terminated string

Returns

Valid pointer to the child node if successful, null pointer otherwise

Retrieves a pointer to the filter shader child with the corresponding name. If no corresponding child is found, either because it has never been declared with addFilterShader() or if the child is optional and disabled by the user, the function returns a null pointer.

const IEnvironment *getScalarShaderChild(const char *childName) const

[virtual]

Parameters

childName – Child name as a null terminated string

Returns

Valid pointer to the child node if successful, null pointer otherwise

Retrieves a pointer to the scalar shader child with the corresponding name. If no corresponding child is found, either because it has never been declared with addScalarShader() or if the child is optional and disabled by the user, the function returns a null pointer.

const IEnvironment *getNormalShaderChild(const char *childName) const

[virtual]

Parameters

childName – Child name as a null terminated string

Returns

Valid pointer to the child node if successful, null pointer otherwise

Retrieves a pointer to the normal shader child with the corresponding name. If no corresponding child is found, either because it has never been declared with addNormalShader() or if the child is optional and disabled by the user, the function returns a null pointer.

~IPrepareContext()

[virtual]

The destructor for IPrepareContext