TextureDefinition
- class HPS.TextureDefinition : public HPS.Definition
The TextureDefinition class is a smart pointer to a database object. It is a handler to a texture defined within a portfolio.
Public Functions
- override void Dispose ()
- override HPS.Type ObjectType ()
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void SetOptions (HPS.TextureOptionsKit in_options)
Redefine the texture options for this TextureDefinition.
- Param in_options
The new texture options for this TextureDefinition.
- void SetSource (HPS.ImageDefinition in_source)
Redefine the image for this TextureDefinition.
- Param in_source
The new image for this TextureDefinition.
- void ShowOptions (out HPS.TextureOptionsKit out_options)
Show the texture options for this TextureDefinition.
- Param out_options
The texture options for this TextureDefinition.
- bool ShowSource (out HPS.ImageDefinition out_source)
Show the image for this TextureDefinition.
- Param out_source
The image for this TextureDefinition.
- Return
true if an image definition was found in the same Portfolio as this TextureDefinition, false otherwise.
- bool ShowSource (out string out_source)
Show the name of the source image for this TextureDefinition. If the source image for this TextureDefinition resides in a separate portfolio, users can use this method to retrieve the name of the source image, and use KeyPath.ShowEffectiveImageDefinition with the image name to retrieve the image definition.
- Param out_source
The name of the source image for this TextureDefinition.
- Return
true if able to retrieve the name of the source image, false otherwise.
- TextureDefinition ()
The default constructor creates an uninitialized TextureDefinition object. The Type() function will return Type.None.
- TextureDefinition (HPS.Definition in_that)
This constructor creates a TextureDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a texture definition. Otherwise the copy will fail and the resulting TextureDefinition will be invalid.
- Param in_that
The source Definition to copy.
- TextureDefinition (HPS.TextureDefinition in_that)
The copy constructor creates an TextureDefinition object that shares the underlying smart-pointer of the source TextureDefinition.
- Param in_that
The source TextureDefinition to copy.