Simplygon C++ API  8.3.35800.0
SimplygonSDK::ITexture Class Referenceabstract

#include <SimplygonSDK.h>

Inheritance diagram for SimplygonSDK::ITexture:
SimplygonSDK::IObject

Public Member Functions

virtual void ChangeTexturePrefixPath (const char *current_path_prefix, const char *new_path_prefix)=0
 
virtual const char * GetClass ()
 
virtual rstring GetFilePath ()=0
 
virtual CountedPointer< IImageDataGetImageData ()=0
 
virtual bool IsA (const char *type) const
 
virtual void SetFilePath (const char *value)=0
 
virtual void SetImageData (IImageData *value)=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 ITextureSafeCast (IObject *ptr)
 
- Static Public Member Functions inherited from SimplygonSDK::IObject
static bool IsClassA (const char *type)
 
static IObjectSafeCast (IObject *ptr)
 

Detailed Description

IMaterial keeps information on materials used while rendering.

Definition at line 15458 of file SimplygonSDK.h.

Member Function Documentation

◆ ChangeTexturePrefixPath()

virtual void SimplygonSDK::ITexture::ChangeTexturePrefixPath ( const char *  current_path_prefix,
const char *  new_path_prefix 
)
pure virtual

Changes the prefix path (drive, directory) in the texture, with the new one, if the current path matches the current_path_prefix. This method is useful when external textures are placed in a specific folder, which needs to be moved

Parameters
current_path_prefixthe current prefix path, either relative or absolute
new_path_prefixthe new prefix path

◆ GetClass()

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

◆ GetFilePath()

virtual rstring SimplygonSDK::ITexture::GetFilePath ( )
pure virtual

Get the file path of the texture.

Returns
the texture file name

◆ GetImageData()

virtual CountedPointer<IImageData> SimplygonSDK::ITexture::GetImageData ( )
pure virtual

Get a named texture image data. If this is defined, it will be used instead of the texture file defined in SetFilePath()

Returns
the texture object

◆ IsA()

virtual bool SimplygonSDK::ITexture::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::IObject.

◆ IsClassA()

static bool SimplygonSDK::ITexture::IsClassA ( const char *  type)
inlinestatic

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

◆ SafeCast()

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

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

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

Definition at line 15492 of file SimplygonSDK.h.

◆ SetFilePath()

virtual void SimplygonSDK::ITexture::SetFilePath ( const char *  value)
pure virtual

Set the file path of the texture.

Parameters
valueis the path to the texture file

◆ SetImageData()

virtual void SimplygonSDK::ITexture::SetImageData ( IImageData value)
pure virtual

Set a named texture image data. If this is defined, it will be used instead of the texture file defined in SetFilePath()

Parameters
valueis the image data object containing the texture data

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