#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LightingAttributeControl |
![]() | |
static const HPS::Type | staticType = HPS::Type::Control |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
Detailed Description
The HPS::LightingAttributeControl class is a smart pointer that is tied to a database object. This control is used to set the lighting interpolation algorithm.
This table lists default values for the various segment attributes accessible from HPS::LightingAttributeControl.
Constructor & Destructor Documentation
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::LightingAttributeControl::LightingAttributeControl | ( | LightingAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::LightingAttributeControl::LightingAttributeControl | ( | LightingAttributeControl && | in_that | ) |
The move constructor creates a LightingAttributeControl by transferring the underlying impl of the rvalue reference to this LightingAttributeControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a LightingAttributeControl to take the impl from.
HPS::LightingAttributeControl::~LightingAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
LightingAttributeControl& HPS::LightingAttributeControl::operator= | ( | LightingAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LightingAttributeControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a LightingAttributeControl to take the impl from.
- Returns
- A reference to this LightingAttributeControl.
LightingAttributeControl& HPS::LightingAttributeControl::operator= | ( | LightingAttributeControl const & | in_that | ) |
Share the underlying smart-pointer of the LightingAttributeControl source.
- Parameters
-
in_that The LightingAttributeControl source of the assignment.
- Returns
- A reference to this LightingAttributeControl.
LightingAttributeControl& HPS::LightingAttributeControl::SetInterpolationAlgorithm | ( | Lighting::InterpolationAlgorithm | in_interpolation | ) |
Sets the interpolation algorithm that will be used for rendering lit faces.
- Parameters
-
in_interpolation The algorithm that will be used for rendering lit faces.
- Returns
- A reference to this object.
bool HPS::LightingAttributeControl::ShowInterpolationAlgorithm | ( | Lighting::InterpolationAlgorithm & | out_interpolation | ) | const |
Shows the interpolation algorithm that will be used for rendering lit faces.
- Parameters
-
out_interpolation The algorithm that will be used for rendering lit faces.
- Returns
- true if the setting is valid, false otherwise.
|
inlinevirtual |
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
LightingAttributeControl& HPS::LightingAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by LightingAttributeKit::GetDefault().
- Returns
- A reference to this object.
LightingAttributeControl& HPS::LightingAttributeControl::UnsetInterpolationAlgorithm | ( | ) |
Removes the interpolation algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by LightingAttributeKit::GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h