SimplygonSDK::IShadingTextureNode Class Reference

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::IShadingTextureNode:

Public Member Functions
virtual const char *	GetClass ()
virtual real	GetOffsetU ()=0
virtual real	GetOffsetV ()=0
virtual int	GetTextureLevel ()=0
virtual rstring	GetTextureLevelName ()=0
virtual rstring	GetTextureName ()=0
virtual int	GetTextureWrapMode ()=0
virtual real	GetTileU ()=0
virtual real	GetTileV ()=0
virtual bool	GetUseSRGB ()=0
virtual bool	IsA (const char *type) const
virtual void	SetOffsetU (real value)=0
virtual void	SetOffsetV (real value)=0
virtual void	SetTextureLevel (int value)=0
virtual void	SetTextureLevelName (const char *value)=0
virtual void	SetTextureName (const char *value)=0
virtual void	SetTextureWrapMode (int value)=0
virtual void	SetTileU (real value)=0
virtual void	SetTileV (real value)=0
virtual void	SetUseSRGB (bool value)=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 IShadingTextureNode *	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

ITextureNode describes a texture source node in a shading network.

Definition at line 16127 of file SimplygonSDK.h.

Member Function Documentation

GetClass()

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

GetOffsetU()

virtual real SimplygonSDK::IShadingTextureNode::GetOffsetU ( )

pure virtual

Gets the OffsetU value, which is will be added to the U-coordinate when sampling

Returns

the current value

GetOffsetV()

virtual real SimplygonSDK::IShadingTextureNode::GetOffsetV ( )

pure virtual

Gets the OffsetV value, which is will be added to the U-coordinate when sampling

Returns

the current value

GetTextureLevel()

virtual int SimplygonSDK::IShadingTextureNode::GetTextureLevel ( )

pure virtual

Set the texture texture coordinate level. The texture level is used during casting if the TextureLevelName has not been set. Setting the TextureLevelName is still required for generating shader code.

Returns

the current texture level

GetTextureLevelName()

virtual rstring SimplygonSDK::IShadingTextureNode::GetTextureLevelName ( )

pure virtual

Get the name of the texture coordinate level. If not set, the material uses the texture level (index) instead. The TextureLevelName is required when generating shader data.

Returns

the current texture level name

GetTextureName()

virtual rstring SimplygonSDK::IShadingTextureNode::GetTextureName ( )

pure virtual

Gets the path of the texture file for casting. If both this and texture image is set, the casting uses the texture image.

Returns

the path the texture will be read from.

GetTextureWrapMode()

virtual int SimplygonSDK::IShadingTextureNode::GetTextureWrapMode ( )

pure virtual

Gets the Texture Wrap Mode, which determines what happens to texture samples outside the 0-1 range

Returns

the current SG_TEXTUREWRAPMODE_[...] value

GetTileU()

virtual real SimplygonSDK::IShadingTextureNode::GetTileU ( )

pure virtual

Gets the TileU value, which is multiplied into the U-coordinate when sampling

Returns

the current value

GetTileV()

virtual real SimplygonSDK::IShadingTextureNode::GetTileV ( )

pure virtual

Gets the TileV value, which is multiplied into the U-coordinate when sampling

Returns

the current value

GetUseSRGB()

virtual bool SimplygonSDK::IShadingTextureNode::GetUseSRGB ( )

pure virtual

Gets the use of sRGB when decoding the texture into an RGBA value

IsA()

virtual bool SimplygonSDK::IShadingTextureNode::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::IShadingNode.

IsClassA()

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

inlinestatic

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

SafeCast()

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

inlinestatic

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

Parameters

ptr	is the pointer to be cast into a IShadingTextureNode pointer

Returns

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

Definition at line 16161 of file SimplygonSDK.h.

SetOffsetU()

virtual void SimplygonSDK::IShadingTextureNode::SetOffsetU ( real  value )

pure virtual

Sets the OffsetU value, which is will be added to the U-coordinate when sampling

Parameters

value

is the new value

SetOffsetV()

virtual void SimplygonSDK::IShadingTextureNode::SetOffsetV ( real  value )

pure virtual

Sets the OffsetV value, which is will be added to the V-coordinate when sampling

Parameters

value

is the new value

SetTextureLevel()

virtual void SimplygonSDK::IShadingTextureNode::SetTextureLevel ( int  value )

pure virtual

Set the texture texture coordinate level. The texture level is used during casting if the TextureLevelName has not been set. Setting the TextureLevelName is still required for generating shader code.

Parameters

value

the desired texture level

SetTextureLevelName()

virtual void SimplygonSDK::IShadingTextureNode::SetTextureLevelName ( const char *  value )

pure virtual

Set the name of the texture coordinate level. If not set, the material uses the texture level (index) instead. The TextureLevelName is required when generating shader data.

Parameters

value

the desired texture level name.

SetTextureName()

virtual void SimplygonSDK::IShadingTextureNode::SetTextureName ( const char *  value )

pure virtual

Sets the path of the texture file for casting. If both this and texture image is set, the casting uses the texture image.

Parameters

value

is the path the texture will be read from.

SetTextureWrapMode()

virtual void SimplygonSDK::IShadingTextureNode::SetTextureWrapMode ( int  value )

pure virtual

Sets the Texture Wrap Mode, which determines what happens to texture samples outside the 0-1 range

Parameters

value

is the new SG_TEXTUREWRAPMODE_[...] value

SetTileU()

virtual void SimplygonSDK::IShadingTextureNode::SetTileU ( real  value )

pure virtual

Sets the TileU value, which is multiplied into the U-coordinate when sampling

Parameters

value

is the new value

SetTileV()

virtual void SimplygonSDK::IShadingTextureNode::SetTileV ( real  value )

pure virtual

Sets the TileV value, which is multiplied into the U-coordinate when sampling

Parameters

value

is the new value

SetUseSRGB()

virtual void SimplygonSDK::IShadingTextureNode::SetUseSRGB ( bool  value )

pure virtual

Sets the use of sRGB when decoding the texture into an RGBA value

Parameters

value

is the flag to use sRGB.

---

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

• SimplygonSDK.h