#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LegacyShaderImportOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The ImportOptionsKit class contains settings that will be set on the LegacyShaderKit which is returned by File::Import.
Constructor & Destructor Documentation
◆ ImportOptionsKit() [1/3]
HPS::LegacyShader::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
◆ ImportOptionsKit() [2/3]
HPS::LegacyShader::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
◆ ImportOptionsKit() [3/3]
HPS::LegacyShader::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit && | in_that | ) |
The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
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.
◆ Equals()
bool HPS::LegacyShader::ImportOptionsKit::Equals | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
|
inlinevirtual |
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.
Reimplemented from HPS::Kit.
◆ operator!=()
bool HPS::LegacyShader::ImportOptionsKit::operator!= | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::operator= | ( | ImportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
- Returns
- A reference to this ImportOptionsKit.
◆ operator=() [2/2]
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::operator= | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
- Returns
- A reference to this ImportOptionsKit.
◆ operator==()
bool HPS::LegacyShader::ImportOptionsKit::operator== | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::LegacyShader::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
◆ SetMultitexture()
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::SetMultitexture | ( | bool | in_state | ) |
Sets whether to apply diffuse textures from layers greater than <span class='code>0 on top of the legacy shader when it is applied to geometry.
- Parameters
-
in_state Whether to apply diffuse textures from layers greater than 0 on top of the legacy 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.
◆ SetParameterizationSource()
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::SetParameterizationSource | ( | Parameterization | in_source | ) |
Sets the parameterization source for the legacy shader.
- Parameters
-
in_source The parameterization source for the legacy shader.
- Returns
- A reference to this ImportOptionsKit.
◆ SetTransformMatrix()
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::SetTransformMatrix | ( | MatrixKit const & | in_transform | ) |
Sets the transform matrix for the legacy shader.
- Parameters
-
in_transform The transform matrix for the legacy shader.
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
void HPS::LegacyShader::ImportOptionsKit::Show | ( | ImportOptionsKit & | out_kit | ) | const |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
◆ ShowMultitexture()
bool HPS::LegacyShader::ImportOptionsKit::ShowMultitexture | ( | bool & | out_state | ) | const |
Shows whether to apply diffuse textures from layers greater than 0 on top of the legacy shader when it is applied to geometry.
- Parameters
-
out_state whether to apply diffuse textures from layers greater than 0 on top of the legacy shader when it is applied to geometry.
- Returns
- true if the flag is valid, false otherwise.
◆ ShowParameterizationSource()
bool HPS::LegacyShader::ImportOptionsKit::ShowParameterizationSource | ( | Parameterization & | out_source | ) | const |
Shows the parameterization source for the legacy shader.
- Parameters
-
out_source The parameterization source for the legacy shader.
- Returns
- true if the parameterization source is valid, false otherwise.
◆ ShowTransformMatrix()
bool HPS::LegacyShader::ImportOptionsKit::ShowTransformMatrix | ( | MatrixKit & | out_transform | ) | const |
Shows the transform matrix for the legacy shader.
- Parameters
-
out_transform The transform matrix for the legacy shader.
- Returns
- true if the transform is valid, false otherwise.
◆ UnsetEverything()
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetMultitexture()
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::UnsetMultitexture | ( | ) |
Removes whether to apply diffuse textures from layers greater than 0 on top of the legacy shader when it is applied to geometry.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetParameterizationSource()
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::UnsetParameterizationSource | ( | ) |
Removes the parameterization source for the legacy shader.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTransformMatrix()
ImportOptionsKit& HPS::LegacyShader::ImportOptionsKit::UnsetTransformMatrix | ( | ) |
Removes the transform matrix for the legacy shader.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h