SimplygonSDK::IShadingCustomNode Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IShadingCustomNode:

Public Member Functions
virtual const char *	GetClass ()
virtual unsigned int	GetInputCount ()=0
virtual bool	IsA (const char *type) const
virtual void	SetInputCount (unsigned int value)=0
Public Member Functions inherited from SimplygonSDK::IShadingFilterNode
virtual CountedPointer< IShadingNode >	GetInput (rid input_id)=0
virtual bool	GetParameterIsInputable (rid param_id)=0
virtual bool	SetInput (rid input_id, IShadingNode *input_node)=0
Public Member Functions inherited from SimplygonSDK::IShadingNode
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 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 IShadingCustomNode *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IShadingFilterNode
static bool	IsClassA (const char *type)
static IShadingFilterNode *	SafeCast (IObject *ptr)
Static Public Member Functions inherited from SimplygonSDK::IShadingNode
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

ICustomNode describes a custom shading node in a shading network. The output is produced based on customizable user specified operations. The custom node has a user specified amount of input parameters. Use SetInputCount() to specify the number of inputs. The user has to assign and implement event handlers (called observers) for the custom node to be able to evaluate to colors. See CustomNodeExample and API documentation for further explanations and code samples.

Definition at line 17248 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

virtual const char* SimplygonSDK::IShadingCustomNode::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::IShadingFilterNode.

GetInputCount()

virtual unsigned int SimplygonSDK::IShadingCustomNode::GetInputCount ( )

pure virtual

Gets the number of inputs for this custom node

Returns

the number of inputs for this custom node

IsA()

virtual bool SimplygonSDK::IShadingCustomNode::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::IShadingFilterNode.

IsClassA()

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

inlinestatic

The IsClassA function returns true if IShadingCustomNode 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 17269 of file SimplygonSDK.h.

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IShadingCustomNode pointer

Returns

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

Definition at line 17282 of file SimplygonSDK.h.

SetInputCount()

virtual void SimplygonSDK::IShadingCustomNode::SetInputCount ( unsigned int  value )

pure virtual

Sets the number of inputs for this custom node

Parameters

value

the number of inputs for this custom node

---

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

• SimplygonSDK.h