# class ShadingNotEqualNode

NotEqualNode describes the "is not equal" 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

Property Description
Name The name of the ShadingNotEqualNode 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 ShadingNotEqualNode 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 ShadingNotEqualNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull Returns true if the ShadingNotEqualNode object is invalid. (Inherited from Object)
IsSameObjectAs Returns true if the ShadingNotEqualNode object is valid. (Inherited from Object)
NonNull Returns true if the ShadingNotEqualNode object is valid. (Inherited from Object)
PrintInfo Prints the content/info of the ShadingNotEqualNode 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 spShadingNotEqualNode, and if this is the case, returns the object cast into spShadingNotEqualNode. (Inherited from Object)

# Properties details

# Name

The name of the ShadingNotEqualNode 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

# 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

# GetClass

Get the name of the ShadingNotEqualNode 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 parameter_id ) const;

# Parameters

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

# Return value

Type: real

# GetDefaultParameterBlue

The default parameter values.

# Syntax

real GetDefaultParameterBlue( rid parameter_id ) const;

# Parameters

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

# Return value

Type: real

# GetDefaultParameterGreen

The default parameter values.

# Syntax

real GetDefaultParameterGreen( rid parameter_id ) const;

# Parameters

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

# Return value

Type: real

# GetDefaultParameterRed

The default parameter values.

# Syntax

real GetDefaultParameterRed( rid parameter_id ) const;

# Parameters

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

# Return value

Type: real

# GetInput

The default node inputs.

# Syntax

spShadingNode GetInput( rid input_id ) const;

# Parameters

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

# Return value

Type: ShadingNode

# 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 param_id ) const;

# Parameters

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

# Return value

Type: bool

# GetParameterName

The name of a parameter.

# Syntax

spString GetParameterName( rid parameter_id ) const;

# Parameters

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

# Return value

Type: spString

# IsA

Returns true if ShadingNotEqualNode 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 ShadingNotEqualNode is, or is a descendant of.

# Return value

Type: bool

# IsNull

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

# Syntax

bool IsNull() const;

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# IsSameObjectAs

Returns true if the ShadingNotEqualNode 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

# NonNull

Returns true if the ShadingNotEqualNode 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 ShadingNotEqualNode 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.

# SetDefaultParameter

The default parameter values.

# Syntax

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

# Parameters

Type Name Min Max Description
rid parameter_id 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.

# SetInput

The default node inputs.

# Syntax

bool SetInput( rid input_id , const spShadingNode & input_node ) const;

# Parameters

Type Name Min Max Description
rid input_id The id of the input to be set.
ShadingNode input_node The 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

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

# SafeCast

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

# Syntax

static spShadingNotEqualNode SafeCast( const spObject & object ) const;

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ShadingNotEqualNode