Skip to content
On this page

class Texture

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

Properties

PropertyDescription
ColorSpaceUsed 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.
FilePathThe 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.
ImageDataSet/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.
NameThe name of the Texture object. (Inherited from Object)

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
EqualsCheck 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.
ExportImageDataWrite 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.
GetClassGet the name of the Texture class. (Inherited from Object)
IsAReturns true if Texture is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the Texture object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the Texture object is valid. (Inherited from Object)
NonNullReturns true if the Texture object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the Texture object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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)

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.

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.

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.

Name

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

Methods details

AddObserver

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

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.

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.

GetClass

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

IsA

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

IsNull

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

IsSameObjectAs

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

NonNull

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

PrintInfo

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

RemoveObserver

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

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)

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)