LegacyShaderKit
-
class LegacyShaderKit : public HPS::Kit
Internal use only - customers should not use. The LegacyShaderKit class is a user space object. It is used for specifying all settings related to a LegacyShaderDefinition.
Public Functions
-
virtual bool Empty() const
Indicates whether this LegacyShaderKit has any values set on it.
- Returns:
true if no values are set on this LegacyShaderKit, false otherwise.
-
bool Equals(LegacyShaderKit const &in_kit) const
Check if the source LegacyShaderKit is equivalent to this LegacyShaderKit.
- Parameters:
in_kit – The source LegacyShaderKit to compare to this LegacyShaderKit.
- Returns:
true if the objects are equivalent, false otherwise.
-
LegacyShaderKit()
The default constructor creates an empty LegacyShaderKit object.
-
LegacyShaderKit(LegacyShaderKit &&in_that)
The move constructor creates a LegacyShaderKit by transferring the underlying impl of the rvalue reference to this LegacyShaderKit thereby avoiding a copy and allocation.
- Parameters:
in_that – An rvalue reference to a LegacyShaderKit to take the impl from.
-
LegacyShaderKit(LegacyShaderKit const &in_kit)
The copy constructor creates a new LegacyShaderKit object that contains the same settings as the source LegacyShaderKit.
- Parameters:
in_kit – The source LegacyShaderKit to copy.
-
inline virtual HPS::Type ObjectType() const
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).
- Returns:
The declared type of the object in question, which may differ from the true, underlying type.
-
bool operator!=(LegacyShaderKit const &in_kit) const
Check if the source LegacyShaderKit is not equivalent to this LegacyShaderKit.
- Parameters:
in_kit – The source LegacyShaderKit to compare to this LegacyShaderKit.
- Returns:
true if the objects are not equivalent, false otherwise.
-
LegacyShaderKit &operator=(LegacyShaderKit &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this LegacyShaderKit thereby avoiding a copy.
- Parameters:
in_that – An rvalue reference to a LegacyShaderKit to take the impl from.
- Returns:
A reference to this LegacyShaderKit.
-
LegacyShaderKit &operator=(LegacyShaderKit const &in_kit)
Copies the source LegacyShaderKit into this LegacyShaderKit.
- Parameters:
in_kit – The source LegacyShaderKit to copy.
- Returns:
A reference to this LegacyShaderKit.
-
bool operator==(LegacyShaderKit const &in_kit) const
Check if the source LegacyShaderKit is equivalent to this LegacyShaderKit.
- Parameters:
in_kit – The source LegacyShaderKit to compare to this LegacyShaderKit.
- Returns:
true if the objects are equivalent, false otherwise.
-
void Set(LegacyShaderKit const &in_kit)
Copies the source LegacyShaderKit into this LegacyShaderKit.
- Parameters:
in_kit – The source LegacyShaderKit to copy.
-
LegacyShaderKit &SetMultitexture(bool in_state)
Sets whether to apply diffuse textures from layers greater than <span class=’code>0 on top of the shader when it is applied to geometry.
- Parameters:
in_state – Whether 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 addtional textures will not be applied.
- Returns:
A reference to this LegacyShaderKit.
-
LegacyShaderKit &SetParameterizationSource(LegacyShader::Parameterization in_source)
Sets the parameterization source for the shader.
- Parameters:
in_source – The parameterization source for the shader.
- Returns:
A reference to this LegacyShaderKit.
-
LegacyShaderKit &SetSource(char const *in_source)
Sets the source code for the shader.
- Parameters:
in_source – The source code for the shader.
- Returns:
A reference to this LegacyShaderKit.
-
LegacyShaderKit &SetTransformMatrix(MatrixKit const &in_transform)
Sets the transform matrix for the shader.
- Parameters:
in_transform – The transform matrix for the shader.
- Returns:
A reference to this LegacyShaderKit.
-
void Show(LegacyShaderKit &out_kit) const
Copies this LegacyShaderKit into the given LegacyShaderKit.
- Parameters:
out_kit – The LegacyShaderKit to populate with the contents of this LegacyShaderKit.
-
bool ShowMultitexture(bool &out_state) const
Shows whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.
- Parameters:
out_state – whether 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 ShowParameterizationSource(LegacyShader::Parameterization &out_source) const
Shows the parameterization source for the shader.
- Parameters:
out_source – The parameterization source for the shader.
- Returns:
true if the parameterization source is valid, false otherwise.
-
bool ShowSource(UTF8 &out_source) const
Shows the source code for the shader.
- Parameters:
out_source – The source code for the shader.
- Returns:
true if the source code is valid, false otherwise.
-
bool ShowTransformMatrix(MatrixKit &out_transform) const
Shows the transform matrix for the shader.
- Parameters:
out_transform – The transform matrix for the shader.
- Returns:
true if the transform is valid, false otherwise.
-
LegacyShaderKit &UnsetEverything()
Removes all settings from this LegacyShaderKit.
- Returns:
A reference to this LegacyShaderKit.
-
LegacyShaderKit &UnsetMultitexture()
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 LegacyShaderKit.
-
LegacyShaderKit &UnsetParameterizationSource()
Removes the parameterization source for the shader.
- Returns:
A reference to this LegacyShaderKit.
-
LegacyShaderKit &UnsetSource()
Removes the source code for the shader.
- Returns:
A reference to this LegacyShaderKit.
-
LegacyShaderKit &UnsetTransformMatrix()
Removes the transform matrix for the shader.
- Returns:
A reference to this LegacyShaderKit.
-
virtual ~LegacyShaderKit()
-
virtual bool Empty() const