class Texture ​

Texture describes a texture object, containing either image data or a path that is referenced by texture nodes in materials.

Properties ​

Methods ​

Static methods ​

Properties details ​

ColorSpace ​

Used to override how Simplygon interprets the color space of the texture. Set to Undefined to not override, and let the color space be defined by the underlying image data object.

// Setter
void SetColorSpace( Simplygon::EImageColorSpace value ) const;

// Getter
Simplygon::EImageColorSpace GetColorSpace() const;

// Setter
void SetColorSpace(EImageColorSpace value);

// Getter
EImageColorSpace GetColorSpace();

# Setter
None SetColorSpace(value: EImageColorSpace_*)

# Getter
EImageColorSpace_* GetColorSpace()

FilePath ​

The file path of the texture. This path has two meanings: It can point to an existing file to use as image data for the texture if the image data object is not set. If the image data object is set on the texture, it is the path to where the image should be saved if the owning scene is exported. If you run a pipeline through the batch tool and Simplygon Grid, the returned texture object will have the image data embedded in the texture objects and this path indicates where it should be saved if the texture are to be stored separately. Use ExportImageData() to write out embedded data to the file path, then use GetFilePath() to get the final path for the texture image file.

// Setter
void SetFilePath( const char * value ) const;

// Getter
spString GetFilePath() const;

// Setter
void SetFilePath(string value);

// Getter
string GetFilePath();

# Setter
None SetFilePath(value: str)

# Getter
str GetFilePath()

ImageData ​

Set/Get a named texture image data. If this is defined, it will be used instead of the texture file defined in GetFilePath/SetFilePath(). See the help for GetFilePath() for additional information regarding the file path meaning in conjunction with embedded image data objects.

// Setter
void SetImageData( const spImageData & value ) const;

// Getter
spImageData GetImageData() const;

// Setter
void SetImageData(spImageData value);

// Getter
spImageData GetImageData();

# Setter
None SetImageData(value: spImageData)

# Getter
spImageData GetImageData()

Name ​

The name of the Texture object. (Inherited from Object)

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

// Setter
void SetName(string name);

// Getter
string GetName();

# Setter
None SetName(name: str)

# Getter
str GetName()

Methods details ​

AddObserver ​

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

rid AddObserver( const spObserver & observer ) const;

int AddObserver(spObserver observer);

int AddObserver(observer: spObserver)

Equals ​

Check for equality against other texture. If the texture is external, this method checks whether the path to the data is equal, otherwise it will compare the embedded image data of this texture.

bool Equals( const spTexture & other ) const;

bool Equals(spTexture other);

bool Equals(other: spTexture)

ExportImageData ​

Write out the embedded image data to the file indicated by the set file path. Once this method returns, use GetFilePath() to get the potentially updated final file path used to write the image data file.

bool ExportImageData() const;

bool ExportImageData();

bool ExportImageData()

GetClass ​

Get the name of the Texture class. (Inherited from Object)

spString GetClass() const;

string GetClass();

str GetClass()

IsA ​

Returns true if Texture is a or is a descendant of the class named as the type parameter. (Inherited from Object)

bool IsA( const char * type ) const;

bool IsA(string type);

bool IsA(type: str)

IsNull ​

Returns true if the Texture object is invalid. (Inherited from Object)

bool IsNull() const;

bool IsNull();

bool IsNull()

IsSameObjectAs ​

Returns true if the Texture object is valid. (Inherited from Object)

bool IsSameObjectAs( const spObject & object ) const;

bool IsSameObjectAs(spObject object);

bool IsSameObjectAs(object: spObject)

NonNull ​

Returns true if the Texture object is valid. (Inherited from Object)

bool NonNull() const;

bool NonNull();

bool NonNull()

PrintInfo ​

Prints the content/info of the Texture object to the log. (Inherited from Object)

void PrintInfo() const;

void PrintInfo();

None PrintInfo()

RemoveObserver ​

Removes a previously added observer object. (Inherited from Object)

void RemoveObserver( rid observerId ) const;

void RemoveObserver(int observerId);

None RemoveObserver(observerId: int)

Static methods details ​

IsClassA ​

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

static bool IsClassA( const char * type ) const;

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

SafeCast ​

SafeCast makes sure the input object is of a class that can be cast into spTexture, and if this is the case, returns the object cast into spTexture. (Inherited from Object)

static spTexture SafeCast( const spObject & object ) const;

static spTexture SafeCast(spObject object);

@staticmethod
spTexture SafeCast(object: spObject)