CFunctionGradientNode

class Lib3MF::CFunctionGradientNode : public CImplicitNode

Gradient of a function

PImplicitPort GetInputFunctionID()

Retrieves the input for the function id

Returns:

the input port for the function

PImplicitPort GetInputPos()

Retrieves the input for the position

Returns:

the input port for the position

PImplicitPort GetInputStep()

Retrieves the input for the finite difference step

Returns:

the input port for the finite difference step

void SetScalarOutputName(const std::string &sScalarOutputName)

Sets the name of the referenced scalar output

Parameters:

sScalarOutputName – the name of the scalar output of the referenced function

std::string GetScalarOutputName()

Retrieves the name of the referenced scalar output

Returns:

the name of the scalar output of the referenced function

void SetVectorInputName(const std::string &sVectorInputName)

Sets the name of the referenced vector input

Parameters:

sVectorInputName – the name of the vector input (float3) of the referenced function

std::string GetVectorInputName()

Retrieves the name of the referenced vector input

Returns:

the name of the vector input (float3) of the referenced function

PImplicitPort GetOutputNormalizedGradient()

Retrieves the normalized gradient output

Returns:

the output port for the normalized gradient

PImplicitPort GetOutputGradient()

Retrieves the raw gradient output

Returns:

the output port for the raw gradient

PImplicitPort GetOutputMagnitude()

Retrieves the gradient magnitude output

Returns:

the output port for the gradient magnitude

typedef std::shared_ptr<CFunctionGradientNode> Lib3MF::PFunctionGradientNode

Shared pointer to CFunctionGradientNode to easily allow reference counting.