The ImportOptionsKit class contains settings that will be set on the ShaderKit which is returned by File::Import. More...

Inheritance diagram for HPS.Shader.ImportOptionsKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ImportOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Shader.ImportOptionsKit in_kit)
 Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 The default constructor creates an empty ImportOptionsKit object. More...
 
 ImportOptionsKit (HPS.Shader.ImportOptionsKit in_kit)
 The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.Shader.ImportOptionsKit in_kit)
 Copies the source ImportOptionsKit into this ImportOptionsKit. More...
 
HPS.Shader.ImportOptionsKit SetMultitexture (bool in_state)
 Sets whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. More...
 
HPS.Shader.ImportOptionsKit SetParameterizationSource (HPS.Shader.Parameterization in_source)
 Sets the parameterization source for the shader. More...
 
HPS.Shader.ImportOptionsKit SetTransformMatrix (HPS.MatrixKit in_transform)
 Sets the transform matrix for the shader. More...
 
void Show (out HPS.Shader.ImportOptionsKit out_kit)
 Copies this ImportOptionsKit into the given ImportOptionsKit. More...
 
bool ShowMultitexture (out bool out_state)
 Shows whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. More...
 
bool ShowParameterizationSource (out HPS.Shader.Parameterization out_source)
 Shows the parameterization source for the shader. More...
 
bool ShowTransformMatrix (out HPS.MatrixKit out_transform)
 Shows the transform matrix for the shader. More...
 
HPS.Shader.ImportOptionsKit UnsetEverything ()
 Removes all settings from this ImportOptionsKit. More...
 
HPS.Shader.ImportOptionsKit UnsetMultitexture ()
 Removes whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. More...
 
HPS.Shader.ImportOptionsKit UnsetParameterizationSource ()
 Removes the parameterization source for the shader. More...
 
HPS.Shader.ImportOptionsKit UnsetTransformMatrix ()
 Removes the transform matrix for the shader. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Static Public Member Functions

static bool operator!= (HPS.Shader.ImportOptionsKit a, HPS.Shader.ImportOptionsKit b)
 
static bool operator== (HPS.Shader.ImportOptionsKit a, HPS.Shader.ImportOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ImportOptionsKit class contains settings that will be set on the ShaderKit which is returned by File::Import.

Constructor & Destructor Documentation

HPS.Shader.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

HPS.Shader.ImportOptionsKit.ImportOptionsKit ( HPS.Shader.ImportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

override bool HPS.Shader.ImportOptionsKit.Empty ( )
inlinevirtual

Indicates whether this ImportOptionsKit has any values set on it.

Returns
true if no values are set on this ImportOptionsKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.Shader.ImportOptionsKit.Equals ( HPS.Shader.ImportOptionsKit  in_kit)
inline

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.Shader.ImportOptionsKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.Shader.ImportOptionsKit.Set ( HPS.Shader.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
HPS.Shader.ImportOptionsKit HPS.Shader.ImportOptionsKit.SetMultitexture ( bool  in_state)
inline

Sets whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.

Parameters
in_stateWhether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. If true, the additional textures will be applied; if false, the additional textures will not be applied.
Returns
A reference to this ImportOptionsKit.
HPS.Shader.ImportOptionsKit HPS.Shader.ImportOptionsKit.SetParameterizationSource ( HPS.Shader.Parameterization  in_source)
inline

Sets the parameterization source for the shader.

Parameters
in_sourceThe parameterization source for the shader.
Returns
A reference to this ImportOptionsKit.
HPS.Shader.ImportOptionsKit HPS.Shader.ImportOptionsKit.SetTransformMatrix ( HPS.MatrixKit  in_transform)
inline

Sets the transform matrix for the shader.

Parameters
in_transformThe transform matrix for the shader.
Returns
A reference to this ImportOptionsKit.
void HPS.Shader.ImportOptionsKit.Show ( out HPS.Shader.ImportOptionsKit  out_kit)
inline

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.
bool HPS.Shader.ImportOptionsKit.ShowMultitexture ( out bool  out_state)
inline

Shows whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.

Parameters
out_statewhether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.
Returns
true if the flag is valid, false otherwise.
bool HPS.Shader.ImportOptionsKit.ShowParameterizationSource ( out HPS.Shader.Parameterization  out_source)
inline

Shows the parameterization source for the shader.

Parameters
out_sourceThe parameterization source for the shader.
Returns
true if the parameterization source is valid, false otherwise.
bool HPS.Shader.ImportOptionsKit.ShowTransformMatrix ( out HPS.MatrixKit  out_transform)
inline

Shows the transform matrix for the shader.

Parameters
out_transformThe transform matrix for the shader.
Returns
true if the transform is valid, false otherwise.
HPS.Shader.ImportOptionsKit HPS.Shader.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.
HPS.Shader.ImportOptionsKit HPS.Shader.ImportOptionsKit.UnsetMultitexture ( )
inline

Removes whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.

Returns
A reference to this ImportOptionsKit.
HPS.Shader.ImportOptionsKit HPS.Shader.ImportOptionsKit.UnsetParameterizationSource ( )
inline

Removes the parameterization source for the shader.

Returns
A reference to this ImportOptionsKit.
HPS.Shader.ImportOptionsKit HPS.Shader.ImportOptionsKit.UnsetTransformMatrix ( )
inline

Removes the transform matrix for the shader.

Returns
A reference to this ImportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.Shader.cs