# `class` ShadingMultiplyNode

MultiplyNode describes a single multiplying shading node in a shading network. Input 1 and Input 2 is multiplied per-component.

# Properties

Property	Description
Name	The name of the ShadingMultiplyNode object. (Inherited from Object)

# Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClass	Get the name of the ShadingMultiplyNode class. (Inherited from Object)
GetDefaultParameterAlpha	The default parameter values. (Inherited from ShadingNode)
GetDefaultParameterBlue	The default parameter values. (Inherited from ShadingNode)
GetDefaultParameterGreen	The default parameter values. (Inherited from ShadingNode)
GetDefaultParameterRed	The default parameter values. (Inherited from ShadingNode)
GetInput	The default node inputs. (Inherited from ShadingFilterNode)
GetParameterCount	The input count. (Inherited from ShadingNode)
GetParameterIsInputable	Get if the parameter is inputable. If true, a different node can be set as this parameters value. If false, the parameter can only be set manually and not through a node input. (Inherited from ShadingFilterNode)
GetParameterName	The name of a parameter. (Inherited from ShadingNode)
IsA	Returns true if ShadingMultiplyNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ShadingMultiplyNode object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ShadingMultiplyNode object is valid. (Inherited from Object)
NonNull	Returns true if the ShadingMultiplyNode object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ShadingMultiplyNode object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetDefaultParameter	The default parameter values. (Inherited from ShadingNode)
SetInput	The default node inputs. (Inherited from ShadingFilterNode)

# Static methods

Method	Description
IsClassA	Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast	SafeCast makes sure the input object is of a class that can be cast into spShadingMultiplyNode, and if this is the case, returns the object cast into spShadingMultiplyNode. (Inherited from Object)

# Properties details

# Name

The name of the ShadingMultiplyNode object. (Inherited from Object)

# Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

# SetName parameters

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

# GetName return value

Type: spString

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

# Methods details

# AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

# Syntax

rid AddObserver( const spObserver & observer ) const;

# Parameters

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

# Return value

Type: rid

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

# GetClass

Get the name of the ShadingMultiplyNode class. (Inherited from Object)

# Syntax

spString GetClass() const;

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetDefaultParameterAlpha

The default parameter values.

# Syntax

real GetDefaultParameterAlpha( rid parameterId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	parameterId			The id of the input to be fetched.

# Return value

Type: real

Type	Name	Min	Max	Description
`int`	parameterId			The id of the input to be fetched.

Name	Type	Min	Max	Description
parameterId	`int`			The id of the input to be fetched.

# GetDefaultParameterBlue

The default parameter values.

# Syntax

real GetDefaultParameterBlue( rid parameterId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	parameterId			The id of the input to be fetched.

# Return value

Type: real

Type	Name	Min	Max	Description
`int`	parameterId			The id of the input to be fetched.

Name	Type	Min	Max	Description
parameterId	`int`			The id of the input to be fetched.

# GetDefaultParameterGreen

The default parameter values.

# Syntax

real GetDefaultParameterGreen( rid parameterId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	parameterId			The id of the input to be fetched.

# Return value

Type: real

Type	Name	Min	Max	Description
`int`	parameterId			The id of the input to be fetched.

Name	Type	Min	Max	Description
parameterId	`int`			The id of the input to be fetched.

# GetDefaultParameterRed

The default parameter values.

# Syntax

real GetDefaultParameterRed( rid parameterId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	parameterId			The id of the input to be fetched.

# Return value

Type: real

Type	Name	Min	Max	Description
`int`	parameterId			The id of the input to be fetched.

Name	Type	Min	Max	Description
parameterId	`int`			The id of the input to be fetched.

# GetInput

The default node inputs.

# Syntax

spShadingNode GetInput( rid inputId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	inputId			The id of the input to be fetched.

# Return value

Type: ShadingNode

Type	Name	Min	Max	Description
`int`	inputId			The id of the input to be fetched.

Name	Type	Min	Max	Description
inputId	`int`			The id of the input to be fetched.

# GetParameterCount

The input count.

# Syntax

unsigned int GetParameterCount() const;

# Parameters

GetParameterCount takes no parameters.

# Return value

Type: unsigned int

# GetParameterIsInputable

Get if the parameter is inputable. If true, a different node can be set as this parameters value. If false, the parameter can only be set manually and not through a node input.

# Syntax

bool GetParameterIsInputable( rid paramId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	paramId			The id of the parameter to be checked.

# Return value

Type: bool

Type	Name	Min	Max	Description
`int`	paramId			The id of the parameter to be checked.

Name	Type	Min	Max	Description
paramId	`int`			The id of the parameter to be checked.

# GetParameterName

The name of a parameter.

# Syntax

spString GetParameterName( rid parameterId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	parameterId			The id of the input to fetch the name of.

# Return value

Type: spString

Type	Name	Min	Max	Description
`int`	parameterId			The id of the input to fetch the name of.

Name	Type	Min	Max	Description
parameterId	`int`			The id of the input to fetch the name of.

# IsA

Returns true if ShadingMultiplyNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

bool IsA( const char * type ) const;

# Parameters

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if ShadingMultiplyNode is, or is a descendant of.

# Return value

Type: bool

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if ShadingMultiplyNode is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if ShadingMultiplyNode is, or is a descendant of.

# IsNull

Returns true if the ShadingMultiplyNode object is invalid. (Inherited from Object)

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the ShadingMultiplyNode object is valid. (Inherited from Object)

# Syntax

bool IsSameObjectAs( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

# Return value

Type: bool

Name	Type	Min	Max	Description
object	Object			Object to compare with.

# NonNull

Returns true if the ShadingMultiplyNode object is valid. (Inherited from Object)

# Syntax

bool NonNull() const;

# Parameters

NonNull takes no parameters.

# Return value

Type: bool

# PrintInfo

Prints the content/info of the ShadingMultiplyNode object to the log. (Inherited from Object)

# Syntax

void PrintInfo() const;

# Parameters

PrintInfo takes no parameters.

# RemoveObserver

Removes a previously added observer object. (Inherited from Object)

# Syntax

void RemoveObserver( rid observerId ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Name	Type	Min	Max	Description
observerId	`int`			ObserverId is the id returned by AddObserver when the observer was added.

# SetDefaultParameter

The default parameter values.

# Syntax

void SetDefaultParameter( rid parameterId , real r , real g , real b , real a ) const;

# Parameters

Type	Name	Description
`rid`	parameterId	The id of the input to be set.
`real`	r	The value of red to which the default input will be set.
`real`	g	The value of green to which the default input will be set.
`real`	b	The value of blue to which the default input will be set.
`real`	a	The value of alpha to which the default input will be set.

# Syntax

void SetDefaultParameter(int parameterId, float r, float g, float b, float a);

# Parameters

Type	Name	Description
`int`	parameterId	The id of the input to be set.
`float`	r	The value of red to which the default input will be set.
`float`	g	The value of green to which the default input will be set.
`float`	b	The value of blue to which the default input will be set.
`float`	a	The value of alpha to which the default input will be set.

# Syntax

None SetDefaultParameter(parameterId: int, r: float, g: float, b: float, a: float)

# Parameters

Name	Type	Description
parameterId	`int`	The id of the input to be set.
r	`float`	The value of red to which the default input will be set.
g	`float`	The value of green to which the default input will be set.
b	`float`	The value of blue to which the default input will be set.
a	`float`	The value of alpha to which the default input will be set.

# SetInput

The default node inputs.

# Syntax

bool SetInput( rid inputId , const spShadingNode & inputNode ) const;

# Parameters

Type	Name	Min	Max	Description
`rid`	inputId			The id of the input to be set.
`ShadingNode`	inputNode			The node to be set as input.

# Return value

Type: bool

Type	Name	Min	Max	Description
`int`	inputId			The id of the input to be set.
`ShadingNode`	inputNode			The node to be set as input.

Name	Type	Min	Max	Description
inputId	`int`			The id of the input to be set.
inputNode	`ShadingNode`			The node to be set as input.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

# Syntax

static bool IsClassA( const char * type ) const;

# Parameters

Type	Name	Min	Max	Description
`const char *`	type			Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

Type	Name	Min	Max	Description
`string`	type			Name of the class to check if the class is, or is a descendant of.

Name	Type	Min	Max	Description
type	`str`			Name of the class to check if the class is, or is a descendant of.

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spShadingMultiplyNode, and if this is the case, returns the object cast into spShadingMultiplyNode. (Inherited from Object)

# Syntax

static spShadingMultiplyNode SafeCast( const spObject & object ) const;

# Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

# Return value

Type: ShadingMultiplyNode

← ShadingMinNode ShadingNormalize3Node →

# class ShadingMultiplyNode

# Properties

# Methods

# Static methods

# Properties details

# Name

# Syntax

# SetName parameters

# GetName return value

# Methods details

# AddObserver

# Syntax

# Parameters

# Return value

# GetClass

# Syntax

# Parameters

# Return value

# GetDefaultParameterAlpha

# Syntax

# Parameters

# Return value

# GetDefaultParameterBlue

# Syntax

# Parameters

# Return value

# GetDefaultParameterGreen

# Syntax

# Parameters

# Return value

# GetDefaultParameterRed

# Syntax

# Parameters

# Return value

# GetInput

# Syntax

# Parameters

# Return value

# GetParameterCount

# Syntax

# Parameters

# Return value

# GetParameterIsInputable

# Syntax

# Parameters

# Return value

# GetParameterName

# Syntax

# Parameters

# Return value

# IsA

# Syntax

# Parameters

# Return value

# IsNull

# Syntax

# Parameters

# Return value

# IsSameObjectAs

# Syntax

# Parameters

# Return value

# NonNull

# Syntax

# Parameters

# Return value

# `class` ShadingMultiplyNode