class ShadingColorNode

ColorNode describes a single color source node in a shading network

Properties

Property	Description
Name	The name of the ShadingColorNode 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 ShadingColorNode 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)
GetParameterCount	The input count. (Inherited from ShadingNode)
GetParameterName	The name of a parameter. (Inherited from ShadingNode)
IsA	Returns true if ShadingColorNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ShadingColorNode object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ShadingColorNode object is valid. (Inherited from Object)
NonNull	Returns true if the ShadingColorNode object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ShadingColorNode object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetColor	The color value.
SetDefaultParameter	The default parameter values. (Inherited from ShadingNode)

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 spShadingColorNode, and if this is the case, returns the object cast into spShadingColorNode. (Inherited from Object)

Properties details

Name

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

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

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

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

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

GetName return value

Type: str

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

Syntax

int AddObserver(spObserver observer);

Parameters

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

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

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

Return value

Type: int

GetClass

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

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

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

Syntax

float GetDefaultParameterAlpha(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterAlpha(parameterId: int)

Parameters

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

Return value

Type: float

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

Syntax

float GetDefaultParameterBlue(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterBlue(parameterId: int)

Parameters

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

Return value

Type: float

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

Syntax

float GetDefaultParameterGreen(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterGreen(parameterId: int)

Parameters

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

Return value

Type: float

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

Syntax

float GetDefaultParameterRed(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterRed(parameterId: int)

Parameters

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

Return value

Type: float

GetParameterCount

The input count.

Syntax

unsigned int GetParameterCount() const;

Parameters

GetParameterCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetParameterCount();

Parameters

GetParameterCount takes no parameters.

Return value

Type: uint

Syntax

int GetParameterCount()

Parameters

GetParameterCount takes no parameters.

Return value

Type: int

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

Syntax

string GetParameterName(int parameterId);

Parameters

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

Return value

Type: string

Syntax

str GetParameterName(parameterId: int)

Parameters

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

Return value

Type: str

IsA

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

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

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

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

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

Return value

Type: bool

IsNull

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

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

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

Syntax

bool IsSameObjectAs(spObject object);

Parameters

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

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

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

Return value

Type: bool

NonNull

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

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

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

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

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.

Syntax

void RemoveObserver(int observerId);

Parameters

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

Syntax

None RemoveObserver(observerId: int)

Parameters

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

SetColor

The color value.

Syntax

void SetColor( real r , real g , real b , real a ) const;

Parameters

Type	Name	Min	Max	Description
real	r			The desired value of the red channel.
real	g			The desired value of the green channel.
real	b			The desired value of the blue channel.
real	a			The desired value of the alpha channel.

Syntax

void SetColor(float r, float g, float b, float a);

Parameters

Type	Name	Min	Max	Description
float	r			The desired value of the red channel.
float	g			The desired value of the green channel.
float	b			The desired value of the blue channel.
float	a			The desired value of the alpha channel.

Syntax

None SetColor(r: float, g: float, b: float, a: float)

Parameters

Name	Type	Min	Max	Description
r	float			The desired value of the red channel.
g	float			The desired value of the green channel.
b	float			The desired value of the blue channel.
a	float			The desired value of the alpha channel.

SetDefaultParameter

The default parameter values.

Syntax

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

Parameters

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

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

Syntax

static bool IsClassA(string type);

Parameters

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

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			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 spShadingColorNode, and if this is the case, returns the object cast into spShadingColorNode. (Inherited from Object)

Syntax

static spShadingColorNode SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ShadingColorNode

Syntax

static spShadingColorNode SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ShadingColorNode

Syntax

@staticmethod
spShadingColorNode SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: ShadingColorNode