#include <hps.h>

Inheritance diagram for HPS::LightingAttributeKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (LightingAttributeKit const &in_kit) const
 
 LightingAttributeKit ()
 
 LightingAttributeKit (LightingAttributeKit const &in_kit)
 
 LightingAttributeKit (LightingAttributeKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (LightingAttributeKit const &in_kit) const
 
LightingAttributeKitoperator= (LightingAttributeKit &&in_that)
 
LightingAttributeKitoperator= (LightingAttributeKit const &in_kit)
 
bool operator== (LightingAttributeKit const &in_kit) const
 
void Set (LightingAttributeKit const &in_kit)
 
LightingAttributeKitSetInterpolationAlgorithm (Lighting::InterpolationAlgorithm in_interpolation)
 
void Show (LightingAttributeKit &out_kit) const
 
bool ShowInterpolationAlgorithm (Lighting::InterpolationAlgorithm &out_interpolation) const
 
LightingAttributeKitUnsetEverything ()
 
LightingAttributeKitUnsetInterpolationAlgorithm ()
 
virtual ~LightingAttributeKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static LightingAttributeKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LightingAttributeKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ LightingAttributeKit() [1/3]

HPS::LightingAttributeKit::LightingAttributeKit ( )

Initializes an empty kit.

◆ LightingAttributeKit() [2/3]

HPS::LightingAttributeKit::LightingAttributeKit ( LightingAttributeKit const &  in_kit)

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

Parameters
in_kitThe source object to copy.

◆ LightingAttributeKit() [3/3]

HPS::LightingAttributeKit::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_thatAn rvalue reference to a LightingAttributeKit to take the impl from.

◆ ~LightingAttributeKit()

virtual HPS::LightingAttributeKit::~LightingAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::LightingAttributeKit::Empty ( ) const
virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::LightingAttributeKit::Equals ( LightingAttributeKit const &  in_kit) const

Check if the source LightingAttributeKit is equivalent to this object.

Parameters
in_kitThe source LightingAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static LightingAttributeKit HPS::LightingAttributeKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::LightingAttributeKit::ObjectType ( ) const
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::LightingAttributeKit::operator!= ( LightingAttributeKit const &  in_kit) const

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

Parameters
in_kitThe source LightingAttributeKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

LightingAttributeKit& HPS::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_thatAn rvalue reference to a LightingAttributeKit to take the impl from.
Returns
A reference to this LightingAttributeKit.

◆ operator=() [2/2]

LightingAttributeKit& HPS::LightingAttributeKit::operator= ( LightingAttributeKit const &  in_kit)

Copies the source LightingAttributeKit into this object.

Parameters
in_kitThe source LightingAttributeKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::LightingAttributeKit::operator== ( LightingAttributeKit const &  in_kit) const

Check if the source LightingAttributeKit is equivalent to this object.

Parameters
in_kitThe source LightingAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::LightingAttributeKit::Set ( LightingAttributeKit const &  in_kit)

Copies all settings from the source LightingAttributeKit into this object.

Parameters
in_kitThe source LightingAttributeKit to copy.

◆ SetInterpolationAlgorithm()

LightingAttributeKit& HPS::LightingAttributeKit::SetInterpolationAlgorithm ( Lighting::InterpolationAlgorithm  in_interpolation)

Sets the interpolation algorithm that will be used for rendering lit faces.

Parameters
in_interpolationThe algorithm that will be used for rendering lit faces.
Returns
A reference to this object.

◆ Show()

void HPS::LightingAttributeKit::Show ( LightingAttributeKit out_kit) const

Copies all settings from this LightingAttributeKit into the given LightingAttributeKit.

Parameters
out_kitThe LightingAttributeKit to populate with the contents of this object.

◆ ShowInterpolationAlgorithm()

bool HPS::LightingAttributeKit::ShowInterpolationAlgorithm ( Lighting::InterpolationAlgorithm out_interpolation) const

Shows the interpolation algorithm that will be used for rendering lit faces.

Parameters
out_interpolationThe algorithm that will be used for rendering lit faces.
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

LightingAttributeKit& HPS::LightingAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetInterpolationAlgorithm()

LightingAttributeKit& HPS::LightingAttributeKit::UnsetInterpolationAlgorithm ( )

Removes the interpolation algorithm setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file: