Simplygon C++ API  8.3.35800.0
Public Member Functions | Static Public Member Functions | List of all members
SimplygonSDK::IShadingSwizzlingNode Class Referenceabstract

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IShadingSwizzlingNode:
SimplygonSDK::IShadingFilterNode SimplygonSDK::IShadingNode SimplygonSDK::IObject

Public Member Functions

virtual unsigned int GetAlphaComponent ()=0
 
virtual unsigned int GetBlueComponent ()=0
 
virtual const char * GetClass ()
 
virtual unsigned int GetGreenComponent ()=0
 
virtual unsigned int GetRedComponent ()=0
 
virtual bool IsA (const char *type) const
 
virtual void SetAlphaComponent (unsigned int value)=0
 
virtual void SetBlueComponent (unsigned int value)=0
 
virtual void SetGreenComponent (unsigned int value)=0
 
virtual void SetRedComponent (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 IShadingSwizzlingNode * 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

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

Definition at line 16302 of file SimplygonSDK.h.

Member Function Documentation

◆ GetAlphaComponent()

virtual unsigned int SimplygonSDK::IShadingSwizzlingNode::GetAlphaComponent ( )
pure virtual

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

Returns
the input component index. Allowed values are 0:R 1:G 2:B 3:A

◆ GetBlueComponent()

virtual unsigned int SimplygonSDK::IShadingSwizzlingNode::GetBlueComponent ( )
pure virtual

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

Returns
the input component index. Allowed values are 0:R 1:G 2:B 3:A

◆ GetClass()

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

◆ GetGreenComponent()

virtual unsigned int SimplygonSDK::IShadingSwizzlingNode::GetGreenComponent ( )
pure virtual

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

Returns
the input component index. Allowed values are 0:R 1:G 2:B 3:A

◆ GetRedComponent()

virtual unsigned int SimplygonSDK::IShadingSwizzlingNode::GetRedComponent ( )
pure virtual

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

Returns
the input component index. Allowed values are 0:R 1:G 2:B 3:A

◆ IsA()

virtual bool SimplygonSDK::IShadingSwizzlingNode::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
typeis 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::IShadingSwizzlingNode::IsClassA ( const char *  type)
inlinestatic

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

Parameters
typeis 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 16323 of file SimplygonSDK.h.

◆ SafeCast()

static IShadingSwizzlingNode* SimplygonSDK::IShadingSwizzlingNode::SafeCast ( IObject *  ptr)
inlinestatic

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

Parameters
ptris the pointer to be cast into a IShadingSwizzlingNode pointer
Returns
a pointer to the IShadingSwizzlingNode object, if the cast can be made, and a NULL pointer otherwise

Definition at line 16336 of file SimplygonSDK.h.

◆ SetAlphaComponent()

virtual void SimplygonSDK::IShadingSwizzlingNode::SetAlphaComponent ( unsigned int  value)
pure virtual

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

Parameters
valuethe input component index. Allowed values are 0:R 1:G 2:B 3:A Value cannot be less than 0. Value cannot be greater than 3.

◆ SetBlueComponent()

virtual void SimplygonSDK::IShadingSwizzlingNode::SetBlueComponent ( unsigned int  value)
pure virtual

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

Parameters
valuethe input component index. Allowed values are 0:R 1:G 2:B 3:A Value cannot be less than 0. Value cannot be greater than 3.

◆ SetGreenComponent()

virtual void SimplygonSDK::IShadingSwizzlingNode::SetGreenComponent ( unsigned int  value)
pure virtual

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

Parameters
valuethe input component index. Allowed values are 0:R 1:G 2:B 3:A Value cannot be less than 0. Value cannot be greater than 3.

◆ SetRedComponent()

virtual void SimplygonSDK::IShadingSwizzlingNode::SetRedComponent ( unsigned int  value)
pure virtual

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

Parameters
valuethe input component index. Allowed values are 0:R 1:G 2:B 3:A Value cannot be less than 0. Value cannot be greater than 3.
The documentation for this class was generated from the following file: