SimplygonSDK::IShadingNode Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IShadingNode:

Public Member Functions
virtual const char *	GetClass ()
virtual real	GetDefaultParameterAlpha (rid parameter_id)=0
virtual real	GetDefaultParameterBlue (rid parameter_id)=0
virtual real	GetDefaultParameterGreen (rid parameter_id)=0
virtual real	GetDefaultParameterRed (rid parameter_id)=0
virtual unsigned int	GetParameterCount ()=0
virtual rstring	GetParameterName (rid parameter_id)=0
virtual bool	IsA (const char *type) const
virtual void	SetDefaultParameter (rid parameter_id, real r, real g, real b, real a)=0
Public Member Functions inherited from SimplygonSDK::IObject
virtual rid	AddObserver (robserver *Observer, rid EventId)=0
virtual void	AddRef ()=0
virtual rstring	GetName ()=0
virtual void *	GetUserComponentArea (rid userid)=0
virtual void	PrintInfo ()=0
virtual void	Release ()=0
virtual void	RemoveObserver (rid ObserverId)=0
virtual void	SetName (const char *Name)=0

Static Public Member Functions
static bool	IsClassA (const char *type)
static IShadingNode *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IObject
static bool	IsClassA (const char *type)
static IObject *	SafeCast (IObject *ptr)

Detailed Description

IShadingNode is the parent of all nodes in a shading network.

Definition at line 15942 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

virtual const char* SimplygonSDK::IShadingNode::GetClass ( )

virtual

GetClass returns the name of the class of the object.

Returns

the name of the actual class of the object, as a const char string

Reimplemented from SimplygonSDK::IObject.

Reimplemented in SimplygonSDK::IShadingLessThanNode, SimplygonSDK::IShadingGreaterThanNode, SimplygonSDK::IShadingSinNode, SimplygonSDK::IShadingCosNode, SimplygonSDK::IShadingCross3Node, SimplygonSDK::IShadingDot3Node, SimplygonSDK::IShadingSqrtNode, SimplygonSDK::IShadingNormalize3Node, SimplygonSDK::IShadingLayeredBlendNode, SimplygonSDK::IShadingCustomNode, SimplygonSDK::IShadingInterpolateNode, SimplygonSDK::IShadingVertexColorNode, SimplygonSDK::IShadingNotEqualNode, SimplygonSDK::IShadingEqualNode, SimplygonSDK::IShadingStepNode, SimplygonSDK::IShadingMinNode, SimplygonSDK::IShadingMaxNode, SimplygonSDK::IShadingClampNode, SimplygonSDK::IShadingDivideNode, SimplygonSDK::IShadingPowNode, SimplygonSDK::IShadingMultiplyNode, SimplygonSDK::IShadingSubtractNode, SimplygonSDK::IShadingAddNode, SimplygonSDK::IShadingColorNode, SimplygonSDK::IShadingSwizzlingNode, SimplygonSDK::IShadingTextureNode, and SimplygonSDK::IShadingFilterNode.

GetDefaultParameterAlpha()

virtual real SimplygonSDK::IShadingNode::GetDefaultParameterAlpha ( rid  parameter_id )

pure virtual

Get the default parameter values

Parameters

parameter_id

is the id of the input to be fetched.

Returns

the Alpha default parameter value

GetDefaultParameterBlue()

virtual real SimplygonSDK::IShadingNode::GetDefaultParameterBlue ( rid  parameter_id )

pure virtual

Get the default parameter values

Parameters

parameter_id

is the id of the input to be fetched.

Returns

the Blue default parameter value

GetDefaultParameterGreen()

virtual real SimplygonSDK::IShadingNode::GetDefaultParameterGreen ( rid  parameter_id )

pure virtual

Get the default parameter values

Parameters

parameter_id

is the id of the input to be fetched.

Returns

the Green default parameter value

GetDefaultParameterRed()

virtual real SimplygonSDK::IShadingNode::GetDefaultParameterRed ( rid  parameter_id )

pure virtual

Get the default parameter values

Parameters

parameter_id

is the id of the input to be fetched.

Returns

the Red default parameter value

GetParameterCount()

virtual unsigned int SimplygonSDK::IShadingNode::GetParameterCount ( )

pure virtual

Get the input count

Returns

the input count

GetParameterName()

virtual rstring SimplygonSDK::IShadingNode::GetParameterName ( rid  parameter_id )

pure virtual

Get the name of a parameter

Parameters

parameter_id

is the id of the input to fetch the name of.

Returns

the name of the parameter

IsA()

virtual bool SimplygonSDK::IShadingNode::IsA ( const char *  type ) const

virtual

The IsA function returns true if the object is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the object is, or is a descendant of

Returns

true if the object is of the specified class, false if not

Reimplemented from SimplygonSDK::IObject.

Reimplemented in SimplygonSDK::IShadingLessThanNode, SimplygonSDK::IShadingGreaterThanNode, SimplygonSDK::IShadingSinNode, SimplygonSDK::IShadingCosNode, SimplygonSDK::IShadingCross3Node, SimplygonSDK::IShadingDot3Node, SimplygonSDK::IShadingSqrtNode, SimplygonSDK::IShadingNormalize3Node, SimplygonSDK::IShadingLayeredBlendNode, SimplygonSDK::IShadingCustomNode, SimplygonSDK::IShadingInterpolateNode, SimplygonSDK::IShadingVertexColorNode, SimplygonSDK::IShadingNotEqualNode, SimplygonSDK::IShadingEqualNode, SimplygonSDK::IShadingStepNode, SimplygonSDK::IShadingMinNode, SimplygonSDK::IShadingMaxNode, SimplygonSDK::IShadingClampNode, SimplygonSDK::IShadingDivideNode, SimplygonSDK::IShadingPowNode, SimplygonSDK::IShadingMultiplyNode, SimplygonSDK::IShadingSubtractNode, SimplygonSDK::IShadingAddNode, SimplygonSDK::IShadingColorNode, SimplygonSDK::IShadingSwizzlingNode, SimplygonSDK::IShadingTextureNode, and SimplygonSDK::IShadingFilterNode.

IsClassA()

static bool SimplygonSDK::IShadingNode::IsClassA ( const char *  type )

inlinestatic

The IsClassA function returns true if IShadingNode is a or is a descendant of the class named as the type parameter

Parameters

type	is the name of the class to check if the class is, or is a descendant of

Returns

true if the class is of the specified class, false if not

Definition at line 15963 of file SimplygonSDK.h.

SafeCast()

static IShadingNode* SimplygonSDK::IShadingNode::SafeCast ( IObject *  ptr )

inlinestatic

SafeCast makes sure the pointer is of a class that can be cast into a IShadingNode pointer, and if this is possible, returns the cast pointer.

Parameters

ptr	is the pointer to be cast into a IShadingNode pointer

Returns

a pointer to the IShadingNode object, if the cast can be made, and a NULL pointer otherwise

Definition at line 15976 of file SimplygonSDK.h.

SetDefaultParameter()

virtual void SimplygonSDK::IShadingNode::SetDefaultParameter ( rid  parameter_id, real  r, real  g, real  b, real  a  )

pure virtual

Set the default parameter values

Parameters

parameter_id	is the id of the input to be set.
r	is the value of red to which the default input will be set.
g	is the value of green to which the default input will be set.
b	is the value of blue to which the default input will be set.
a	is the value of alpha to which the default input will be set.

---

The documentation for this class was generated from the following file:

• SimplygonSDK.h