LightingAttributeControl
-
class
LightingAttributeControl: public HPS::Control 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.
Public Functions
-
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.
-
LightingAttributeControl(LightingAttributeControl const &in_that) Initializes a control tied to the same object as in_that.
-
explicit
LightingAttributeControl(SegmentKey &in_seg) Initializes a control tied to the segment in_seg.
-
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.
-
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 &
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 &
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
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.
-
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 &
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.
-
~LightingAttributeControl() Releases a reference to the database object this control is tied to.
-
