class ShadingSwizzlingNode

SwizzlingNode describes a node that can remap the input to the specified output.

Properties

Property	Description
AlphaComponent	The component index in the input color that Alpha component will be copied from.
BlueComponent	The component index in the input color that Blue component will be copied from.
GreenComponent	The component index in the input color that Green component will be copied from.
RedComponent	The component index in the input color that Red component will be copied from.

Methods

Method	Description
GetClass	Get the name of the ShadingSwizzlingNode class.
GetDefaultParameterAlpha	The default parameter values.
GetDefaultParameterBlue	The default parameter values.
GetDefaultParameterGreen	The default parameter values.
GetDefaultParameterRed	The default parameter values.
GetInput	The default node inputs.
GetParameterCount	The input count.
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.
GetParameterName	The name of a parameter.
IsA	Returns true if ShadingSwizzlingNode is a or is a descendant of the class named as the type parameter.
IsNull	Returns true if the ShadingSwizzlingNode object is invalid.
SetDefaultParameter	The default parameter values.
SetInput	The default node inputs.

Static methods

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

Properties details

AlphaComponent

The component index in the input color that Alpha component will be copied from.

Syntax

// Setter
void SetAlphaComponent( unsigned int value );

// Getter
unsigned int GetAlphaComponent();

SetAlphaComponent parameters

Type	Name	Min	Max	Description
unsigned int	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetAlphaComponent return value

Type: unsigned int

Syntax

// Setter
void SetAlphaComponent(uint value);

// Getter
uint GetAlphaComponent();

SetAlphaComponent parameters

Type	Name	Min	Max	Description
uint	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetAlphaComponent return value

Type: uint

Syntax

# Setter
None SetAlphaComponent(value: int)

# Getter
int GetAlphaComponent()

SetAlphaComponent parameters

Name	Type	Min	Max	Description
value	int	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetAlphaComponent return value

Type: int

BlueComponent

The component index in the input color that Blue component will be copied from.

Syntax

// Setter
void SetBlueComponent( unsigned int value );

// Getter
unsigned int GetBlueComponent();

SetBlueComponent parameters

Type	Name	Min	Max	Description
unsigned int	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetBlueComponent return value

Type: unsigned int

Syntax

// Setter
void SetBlueComponent(uint value);

// Getter
uint GetBlueComponent();

SetBlueComponent parameters

Type	Name	Min	Max	Description
uint	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetBlueComponent return value

Type: uint

Syntax

# Setter
None SetBlueComponent(value: int)

# Getter
int GetBlueComponent()

SetBlueComponent parameters

Name	Type	Min	Max	Description
value	int	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetBlueComponent return value

Type: int

GreenComponent

The component index in the input color that Green component will be copied from.

Syntax

// Setter
void SetGreenComponent( unsigned int value );

// Getter
unsigned int GetGreenComponent();

SetGreenComponent parameters

Type	Name	Min	Max	Description
unsigned int	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetGreenComponent return value

Type: unsigned int

Syntax

// Setter
void SetGreenComponent(uint value);

// Getter
uint GetGreenComponent();

SetGreenComponent parameters

Type	Name	Min	Max	Description
uint	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetGreenComponent return value

Type: uint

Syntax

# Setter
None SetGreenComponent(value: int)

# Getter
int GetGreenComponent()

SetGreenComponent parameters

Name	Type	Min	Max	Description
value	int	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetGreenComponent return value

Type: int

RedComponent

The component index in the input color that Red component will be copied from.

Syntax

// Setter
void SetRedComponent( unsigned int value );

// Getter
unsigned int GetRedComponent();

SetRedComponent parameters

Type	Name	Min	Max	Description
unsigned int	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetRedComponent return value

Type: unsigned int

Syntax

// Setter
void SetRedComponent(uint value);

// Getter
uint GetRedComponent();

SetRedComponent parameters

Type	Name	Min	Max	Description
uint	value	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetRedComponent return value

Type: uint

Syntax

# Setter
None SetRedComponent(value: int)

# Getter
int GetRedComponent()

SetRedComponent parameters

Name	Type	Min	Max	Description
value	int	0	3	The input component index. Allowed values are 0:R 1:G 2:B 3:A.

GetRedComponent return value

Type: int

Methods details

GetClass

Get the name of the ShadingSwizzlingNode class.

Syntax

spString GetClass();

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 parameter_id );

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterAlpha(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterAlpha(parameter_id: int)

Parameters

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

Return value

Type: float

GetDefaultParameterBlue

The default parameter values.

Syntax

real GetDefaultParameterBlue( rid parameter_id );

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterBlue(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterBlue(parameter_id: int)

Parameters

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

Return value

Type: float

GetDefaultParameterGreen

The default parameter values.

Syntax

real GetDefaultParameterGreen( rid parameter_id );

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterGreen(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterGreen(parameter_id: int)

Parameters

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

Return value

Type: float

GetDefaultParameterRed

The default parameter values.

Syntax

real GetDefaultParameterRed( rid parameter_id );

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterRed(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterRed(parameter_id: int)

Parameters

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

Return value

Type: float

GetInput

The default node inputs.

Syntax

spShadingNode GetInput( rid input_id );

Parameters

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

Return value

Type: ShadingNode

Syntax

spShadingNode GetInput(rid input_id);

Parameters

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

Return value

Type: ShadingNode

Syntax

spShadingNode GetInput(input_id: int)

Parameters

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

Return value

Type: ShadingNode

GetParameterCount

The input count.

Syntax

unsigned int GetParameterCount();

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

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 );

Parameters

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

Return value

Type: bool

Syntax

bool GetParameterIsInputable(rid param_id);

Parameters

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

Return value

Type: bool

Syntax

bool GetParameterIsInputable(param_id: int)

Parameters

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

Return value

Type: bool

GetParameterName

The name of a parameter.

Syntax

spString GetParameterName( rid parameter_id );

Parameters

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

Return value

Type: spString

Syntax

string GetParameterName(rid parameter_id);

Parameters

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

Return value

Type: string

Syntax

str GetParameterName(parameter_id: int)

Parameters

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

Return value

Type: str

IsA

Returns true if ShadingSwizzlingNode is a or is a descendant of the class named as the type parameter.

Syntax

bool IsA( const char * type );

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if ShadingSwizzlingNode 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 ShadingSwizzlingNode 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 ShadingSwizzlingNode is, or is a descendant of.

Return value

Type: bool

IsNull

Returns true if the ShadingSwizzlingNode object is invalid.

Syntax

bool IsNull();

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

SetDefaultParameter

The default parameter values.

Syntax

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

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.

Syntax

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

Parameters

Type	Name	Min	Max	Description
rid	parameter_id			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(parameter_id: int, r: float, g: float, b: float, a: float)

Parameters

Name	Type	Min	Max	Description
parameter_id	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 input_id , spShadingNode input_node );

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

Syntax

bool SetInput(rid input_id, spShadingNode input_node);

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

Syntax

bool SetInput(input_id: int, input_node: spShadingNode)

Parameters

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

Syntax

static bool IsClassA( const char * type );

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 spShadingSwizzlingNode, and if this is the case, returns the object cast into spShadingSwizzlingNode.

Syntax

static spShadingSwizzlingNode SafeCast( spObject object );

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ShadingSwizzlingNode

Syntax

static spShadingSwizzlingNode SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ShadingSwizzlingNode

Syntax

@staticmethod
spShadingSwizzlingNode SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: ShadingSwizzlingNode