LightingAttributeKit

class HPS::LightingAttributeKit : public HPS::Kit 

The HPS::LightingAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::LightingAttributeKit::GetDefault() will return a kit with values found in this table.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

bool Equals(LightingAttributeKit const &in_kit) const

Check if the source LightingAttributeKit is equivalent to this object.

Parameters: in_kit – The source LightingAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

LightingAttributeKit(): Initializes an empty kit.

LightingAttributeKit(LightingAttributeKit &&in_that)

The move constructor creates a LightingAttributeKit by transferring the underlying impl of the rvalue reference to this LightingAttributeKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a LightingAttributeKit to take the impl from.

LightingAttributeKit(LightingAttributeKit const &in_kit)

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

Parameters: in_kit – The source object 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!=(LightingAttributeKit const &in_kit) const

Check if the source LightingAttributeKit is not equivalent to this object.

Parameters: in_kit – The source LightingAttributeKit to compare to this object.
Returns: true if the objects are not equivalent, false otherwise.

LightingAttributeKit &operator=(LightingAttributeKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this LightingAttributeKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a LightingAttributeKit to take the impl from.
Returns: A reference to this LightingAttributeKit.

LightingAttributeKit &operator=(LightingAttributeKit const &in_kit)

Copies the source LightingAttributeKit into this object.

Parameters: in_kit – The source LightingAttributeKit to copy.
Returns: A reference to this object.

bool operator==(LightingAttributeKit const &in_kit) const

Check if the source LightingAttributeKit is equivalent to this object.

Parameters: in_kit – The source LightingAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

void Set(LightingAttributeKit const &in_kit)

Copies all settings from the source LightingAttributeKit into this object.

Parameters: in_kit – The source LightingAttributeKit to copy.

LightingAttributeKit &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.

void Show(LightingAttributeKit &out_kit) const

Copies all settings from this LightingAttributeKit into the given LightingAttributeKit.

Parameters: out_kit – The LightingAttributeKit to populate with the contents of 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.

LightingAttributeKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

LightingAttributeKit &UnsetInterpolationAlgorithm()

Removes the interpolation algorithm setting.

Returns: A reference to this object.

virtual ~LightingAttributeKit(): Destroy this kit.

Public Static Functions

static LightingAttributeKit GetDefault()

Creates a LightingAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns: A LightingAttributeKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::LightingAttributeKit