Skip to content

class ShadingEqualNode

ShadingEqualNode describes an "is equal to" operator, where the per-component output is either 1 or 0 depending on if input0 is equal to input1. Basically, (Input0 == Input1) ? 1 : 0

Properties

PropertyDescription
NameThe name of the ShadingEqualNode object. (Inherited from Object)

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClassGet the name of the ShadingEqualNode class. (Inherited from Object)
GetDefaultParameterAlphaThe default parameter values. (Inherited from ShadingNode)
GetDefaultParameterBlueThe default parameter values. (Inherited from ShadingNode)
GetDefaultParameterGreenThe default parameter values. (Inherited from ShadingNode)
GetDefaultParameterRedThe default parameter values. (Inherited from ShadingNode)
GetInputThe default node inputs. (Inherited from ShadingFilterNode)
GetParameterCountThe input count. (Inherited from ShadingNode)
GetParameterIsInputableGet 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)
GetParameterNameThe name of a parameter. (Inherited from ShadingNode)
IsAReturns true if ShadingEqualNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the ShadingEqualNode object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ShadingEqualNode object is valid. (Inherited from Object)
NonNullReturns true if the ShadingEqualNode object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ShadingEqualNode object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SetDefaultParameterThe default parameter values. (Inherited from ShadingNode)
SetInputThe default node inputs. (Inherited from ShadingFilterNode)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into spShadingEqualNode, and if this is the case, returns the object cast into spShadingEqualNode. (Inherited from Object)

Properties details

Name

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

Syntax

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

// Getter
spString GetName() const;

SetName parameters

TypeNameMinMaxDescription
const char *nameNew name of the object.

GetName return value

Type: spString

Methods details

AddObserver

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

Syntax

cpp
rid AddObserver( const spObserver & observer ) const;

Parameters

TypeNameMinMaxDescription
ObserverobserverObserver is the object that will receive events.

Return value

Type: rid

GetClass

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

Syntax

cpp
spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

GetDefaultParameterAlpha

The default parameter values.

Syntax

cpp
real GetDefaultParameterAlpha( rid parameterId ) const;

Parameters

TypeNameMinMaxDescription
ridparameterIdThe id of the input to be fetched.

Return value

Type: real

GetDefaultParameterBlue

The default parameter values.

Syntax

cpp
real GetDefaultParameterBlue( rid parameterId ) const;

Parameters

TypeNameMinMaxDescription
ridparameterIdThe id of the input to be fetched.

Return value

Type: real

GetDefaultParameterGreen

The default parameter values.

Syntax

cpp
real GetDefaultParameterGreen( rid parameterId ) const;

Parameters

TypeNameMinMaxDescription
ridparameterIdThe id of the input to be fetched.

Return value

Type: real

GetDefaultParameterRed

The default parameter values.

Syntax

cpp
real GetDefaultParameterRed( rid parameterId ) const;

Parameters

TypeNameMinMaxDescription
ridparameterIdThe id of the input to be fetched.

Return value

Type: real

GetInput

The default node inputs.

Syntax

cpp
spShadingNode GetInput( rid inputId ) const;

Parameters

TypeNameMinMaxDescription
ridinputIdThe id of the input to be fetched.

Return value

Type: ShadingNode

GetParameterCount

The input count.

Syntax

cpp
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

cpp
bool GetParameterIsInputable( rid paramId ) const;

Parameters

TypeNameMinMaxDescription
ridparamIdThe id of the parameter to be checked.

Return value

Type: bool

GetParameterName

The name of a parameter.

Syntax

cpp
spString GetParameterName( rid parameterId ) const;

Parameters

TypeNameMinMaxDescription
ridparameterIdThe id of the input to fetch the name of.

Return value

Type: spString

IsA

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

Syntax

cpp
bool IsA( const char * type ) const;

Parameters

TypeNameMinMaxDescription
const char *typeName of the class to check if ShadingEqualNode is, or is a descendant of.

Return value

Type: bool

IsNull

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

Syntax

cpp
bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

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

Syntax

cpp
bool IsSameObjectAs( const spObject & object ) const;

Parameters

TypeNameMinMaxDescription
ObjectobjectObject to compare with.

Return value

Type: bool

NonNull

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

Syntax

cpp
bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

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

Syntax

cpp
void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

RemoveObserver

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

Syntax

cpp
void RemoveObserver( rid observerId ) const;

Parameters

TypeNameMinMaxDescription
ridobserverIdObserverId is the id returned by AddObserver when the observer was added.

SetDefaultParameter

The default parameter values.

Syntax

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

Parameters

TypeNameMinMaxDescription
ridparameterIdThe id of the input to be set.
realrThe value of red to which the default input will be set.
realgThe value of green to which the default input will be set.
realbThe value of blue to which the default input will be set.
realaThe value of alpha to which the default input will be set.

SetInput

The default node inputs.

Syntax

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

Parameters

TypeNameMinMaxDescription
ridinputIdThe id of the input to be set.
ShadingNodeinputNodeThe node to be set as input.

Return value

Type: bool

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

cpp
static bool IsClassA( const char * type ) const;

Parameters

TypeNameMinMaxDescription
const char *typeName of the class to check if the class is, or is a descendant of.

Return value

Type: bool

SafeCast

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

Syntax

cpp
static spShadingEqualNode SafeCast( const spObject & object ) const;

Parameters

TypeNameMinMaxDescription
ObjectobjectObject to cast.

Return value

Type: ShadingEqualNode