TextureOptionsKit

class HPS.TextureOptionsKit : HPS.Kit

The TextureOptionsKit class is a user space object. It is used for setting texture options when defining textures or cube maps. Calling HPS.TextureOptionsKit.GetDefault() will return an options kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this TextureOptionsKit has any values set on it.

Return:true if no values are set on this TextureOptionsKit, false otherwise.

bool Equals (HPS.TextureOptionsKit in_kit)

Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit.

Param in_kit:The source TextureOptionsKit to compare to this TextureOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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 Set (HPS.TextureOptionsKit in_kit)

Copies the source TextureOptionsKit into this TextureOptionsKit.

Param in_kit:The source TextureOptionsKit to copy.

HPS.TextureOptionsKit SetDecal (bool in_state)

Sets whether the texture should act as a decal, i.e., whether diffuse colors will be allowed through transparent portions of a diffuse texture. This only affects a diffuse texture on layer 0.

Param in_state:Whether the texture should act as a decal. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetDecimationFilter (HPS.Material.Texture.Decimation in_filter)

Sets the decimation filter to use for the texture.

Param in_filter:  The decimation filter to use for the texture. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetDownSampling (bool in_state)

Sets whether the texture should be down-sampled.

Param in_state:Whether the texture should be down-sampled. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetInterpolationFilter (HPS.Material.Texture.Interpolation in_filter)

Sets the interpolation filter to use for the texture.

Param in_filter:  The interpolation filter to use for the texture. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetModulation (bool in_state)

Sets whether the texture should be modulated with materials from layers below it. This only applies to diffuse textures.

Param in_state:Whether the texture should be modulated with materials from layers below it. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetParameterizationSource (HPS.Material.Texture.Parameterization in_source)

Sets the parameterization source for the texture.

Param in_source:  The parameterization source for the texture. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetParameterOffset (ulong in_offset)

Sets the parameter offset for the texture, i.e., the offset into the texture parameter list to use at each vertex to locate the parameters for the texture.

Param in_offset:  The parameter offset for the texture. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetTiling (HPS.Material.Texture.Tiling in_tiling)

Sets how the texture will be tiled for parameters outside the range [0, 1].

Param in_tiling:  How the texture will be tiled for parameters outside the range [0, 1]. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetTransformMatrix (HPS.MatrixKit in_transform)

Sets the transform matrix to use for the texture.

Param in_transform:  The transform matrix to use for the texture. Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit SetValueScale (float in_min, float in_max)

Sets the value scaling (linear remapping) of texture element values.

Param in_min:The value to which zero will be remapped. Param in_max:The value to which one will be remapped. Return:A reference to this TextureOptionsKit.

void Show (out HPS.TextureOptionsKit out_kit)

Copies this TextureOptionsKit into the given TextureOptionsKit.

Param out_kit:The TextureOptionsKit to populate with the contents of this TextureOptionsKit.

bool ShowDecal (out bool out_state)

Shows whether the texture should act as a decal.

Param out_state:  Whether the texture should act as a decal. Return:true if the flag is valid, false otherwise.

bool ShowDecimationFilter (out HPS.Material.Texture.Decimation out_filter)

Shows the decimation filter for the texture.

Param out_filter:  The decimation filter for the texture. Return:true if the filter is valid, false otherwise.

bool ShowDownSampling (out bool out_state)

Shows whether the texture should be down-sampled.

Param out_state:  Whether the texture should be down-sampled. Return:true if the flag is valid, false otherwise.

bool ShowInterpolationFilter (out HPS.Material.Texture.Interpolation out_filter)

Shows the interpolation filter for the texture.

Param out_filter:  The interpolation filter for the texture. Return:true if the filter is valid, false otherwise.

bool ShowModulation (out bool out_state)

Shows whether the texture should be modulated with materials from layers below it.

Param out_state:  Whether the texture should be modulated with materials from layers below it. Return:true if the flag is valid, false otherwise.

bool ShowParameterizationSource (out HPS.Material.Texture.Parameterization out_source)

Shows the parameterization source for the texture.

Param out_source:  The parametererization source for the texture. Return:true if the parameterization source is valid, false otherwise.

bool ShowParameterOffset (out ulong out_offset)

Shows the parameter offset for the texture.

Param out_offset:  The parameter offset for the texture. Return:true if the offset is valid, false otherwise.

bool ShowTiling (out HPS.Material.Texture.Tiling out_tiling)

Shows how the texture will be tiled for parameters outside the range [0, 1].

Param out_tiling:  How the texture will be tiled for parameters outside the range [0, 1]. Return:true if the tiling is valid, false otherwise.

bool ShowTransformMatrix (out HPS.MatrixKit out_transform)

Shows the transform matrix for the texture.

Param out_transform:  The transform matrix for the texture. Return:true if the transform matrix is valid, false otherwise.

bool ShowValueScale (out float out_min, out float out_max)

Shows the value scale for the texture.

Param out_min:The value to which zero will be remapped. Param out_max:The value to which one will be remapped. Return:true if the filter is valid, false otherwise.

TextureOptionsKit ()

The default constructor creates an empty TextureOptionsKit object.

TextureOptionsKit (HPS.TextureOptionsKit in_kit)

The copy constructor creates a new TextureOptionsKit object that contains the same settings as the source TextureOptionsKit.

Param in_kit:The source TextureOptionsKit to copy.

HPS.TextureOptionsKit UnsetDecal ()

Removes whether the texture should act as a decal.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetDecimationFilter ()

Removes the decimation filter for the texture.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetDownSampling ()

Removes whether to down-sample the texture.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetEverything ()

Removes all settings from this TextureOptionsKit.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetInterpolationFilter ()

Removes the interpolation filter for the texture.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetModulation ()

Removes whether the texture should modulate with materials from layers below it.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetParameterizationSource ()

Removes the parameter source for the texture.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetParameterOffset ()

Removes the parameter offset for the texture.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetTiling ()

Removes how the texture will be tiled for parameters outside the range [0, 1].

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetTransformMatrix ()

Removes the transform matrix for the texture.

Return:A reference to this TextureOptionsKit.

HPS.TextureOptionsKit UnsetValueScale ()

Removes the value scale for the texture.

Return:A reference to this TextureOptionsKit.

Public Static Functions

HPS.TextureOptionsKit GetDefault ()

Creates a TextureOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return:A TextureOptionsKit with the default settings.

bool operator!= (HPS.TextureOptionsKit a, HPS.TextureOptionsKit b)

bool operator== (HPS.TextureOptionsKit a, HPS.TextureOptionsKit b)