#include <hps.h>
|
void | Consume (SpotlightKit &in_kit) |
|
HPS::Type | ObjectType () const |
|
SpotlightKey & | operator= (SpotlightKey const &in_that) |
|
SpotlightKey & | operator= (SpotlightKey &&in_that) |
|
void | Set (SpotlightKit const &in_kit) |
|
SpotlightKey & | SetCameraRelative (bool in_state) |
|
SpotlightKey & | SetColor (RGBAColor const &in_rgba_color) |
|
SpotlightKey & | SetColorByIndex (float in_index) |
|
SpotlightKey & | SetConcentration (float in_concentration) |
|
SpotlightKey & | SetInnerCone (float in_size, HPS::Spotlight::InnerConeUnits in_units=HPS::Spotlight::InnerConeUnits::Percent) |
|
SpotlightKey & | SetOuterCone (float in_size, HPS::Spotlight::OuterConeUnits in_units=HPS::Spotlight::OuterConeUnits::Degrees) |
|
SpotlightKey & | SetPosition (HPS::Point const &in_position) |
|
SpotlightKey & | SetTarget (HPS::Point const &in_target) |
|
void | Show (SpotlightKit &out_kit) const |
|
bool | ShowCameraRelative (bool &out_state) const |
|
bool | ShowColor (Material::Type &out_type, RGBAColor &out_rgba_color, float &out_index) const |
|
bool | ShowConcentration (float &out_concentration) const |
|
bool | ShowInnerCone (float &out_size, HPS::Spotlight::InnerConeUnits &out_units) const |
|
bool | ShowOuterCone (float &out_size, HPS::Spotlight::OuterConeUnits &out_units) const |
|
bool | ShowPosition (HPS::Point &out_position) const |
|
bool | ShowTarget (HPS::Point &out_target) const |
|
| SpotlightKey () |
|
| SpotlightKey (Key const &in_that) |
|
| SpotlightKey (SpotlightKey const &in_that) |
|
| SpotlightKey (SpotlightKey &&in_that) |
|
SpotlightKey & | UnsetColor () |
|
| GeometryKey () |
|
| GeometryKey (Key const &in_that) |
|
| GeometryKey (GeometryKey const &in_that) |
|
| GeometryKey (GeometryKey &&in_that) |
|
GeometryKey & | operator= (GeometryKey const &in_that) |
|
GeometryKey & | operator= (GeometryKey &&in_that) |
|
GeometryKey & | SetPriority (int in_priority) |
|
GeometryKey & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
|
GeometryKey & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
|
GeometryKey & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
|
bool | ShowBounding (BoundingKit &out_kit) const |
|
bool | ShowPriority (int &out_priority) const |
|
size_t | ShowReferrers (SegmentKeyArray &out_segments) const |
|
size_t | ShowReferrers (ReferenceKeyArray &out_references) const |
|
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
|
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
|
size_t | ShowUserDataCount () const |
|
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
|
GeometryKey & | UnsetAllUserData () |
|
GeometryKey & | UnsetPriority () |
|
GeometryKey & | UnsetUserData (intptr_t in_index) |
|
GeometryKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
|
GeometryKey & | UnsetUserData (IntPtrTArray const &in_indices) |
|
virtual void | Assign (Key const &in_that) |
|
Key | CopyTo (SegmentKey const &in_destination) const |
|
void | Delete () |
|
bool | Equals (Key const &in_that) const |
|
size_t | GetHash () const |
|
bool | HasOwner () const |
|
| Key () |
|
| Key (Key const &in_that) |
|
| Key (Control const &in_control) |
|
| Key (Key &&in_that) |
|
void | MoveTo (SegmentKey const &in_new_owner) |
|
bool | operator!= (Key const &in_that) const |
|
Key & | operator= (Key &&in_that) |
|
Key & | operator= (Key const &in_that) |
|
bool | operator== (Key const &in_that) const |
|
SegmentKey | Owner () const |
|
SegmentKey | Up () const |
|
virtual | ~Key () |
|
virtual bool | Empty () const |
|
intptr_t | GetClassID () const |
|
intptr_t | GetInstanceID () const |
|
bool | HasType (HPS::Type in_mask) const |
|
| Object (Object const &that) |
|
| Object (Object &&in_that) |
|
Object & | operator= (Object const &other_object) |
|
Object & | operator= (Object &&in_that) |
|
virtual void | Reset () |
|
virtual HPS::Type | Type () const |
|
|
static const HPS::Type | staticType = HPS::Type::SpotlightKey |
|
static const HPS::Type | staticType = HPS::Type::GeometryKey |
|
static const HPS::Type | staticType = HPS::Type::Key |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The SpotlightKey class is a smart pointer to a database object. It is a handle to a spotlight inserted via SegmentKey::InsertSpotlight.
◆ SpotlightKey() [1/4]
HPS::SpotlightKey::SpotlightKey |
( |
| ) |
|
The default constructor creates an uninitialized SpotlightKey object. The Type() function will return Type::None.
◆ SpotlightKey() [2/4]
HPS::SpotlightKey::SpotlightKey |
( |
Key const & |
in_that | ) |
|
|
explicit |
This constructor creates a SpotlightKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a Spotlight key. Otherwise the copy will fail and the resulting SpotlightKey will be invalid.
- Parameters
-
in_key | The source Key to copy. |
◆ SpotlightKey() [3/4]
HPS::SpotlightKey::SpotlightKey |
( |
SpotlightKey const & |
in_that | ) |
|
The copy constructor creates a SpotlightKey object that shares the underlying smart-pointer of the source SpotlightKey.
- Parameters
-
◆ SpotlightKey() [4/4]
The move constructor creates a SpotlightKey by transferring the underlying impl of the rvalue reference to this SpotlightKey thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a SpotlightKey to take the impl from. |
◆ Consume()
Completely replaces all settings on this SpotlightKey with those set on the specified kit and resets the kit.InfiniteLineKey
- Parameters
-
in_kit | The kit from which to get the settings to replace on this SpotlightKey. |
◆ ObjectType()
HPS::Type HPS::SpotlightKey::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::GeometryKey.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this SpotlightKey thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a SpotlightKey to take the impl from. |
- Returns
- A reference to this SpotlightKey.
◆ Set()
Replace those settings on this SpotlightKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this SpotlightKey. |
◆ SetCameraRelative()
SpotlightKey& HPS::SpotlightKey::SetCameraRelative |
( |
bool |
in_state | ) |
|
Sets whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space.
- Parameters
-
in_state | Whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space. |
- Returns
- A reference to this SpotlightKey.
- See also
- SetPosition
-
SetTarget
◆ SetColor()
◆ SetColorByIndex()
SpotlightKey& HPS::SpotlightKey::SetColorByIndex |
( |
float |
in_index | ) |
|
◆ SetConcentration()
SpotlightKey& HPS::SpotlightKey::SetConcentration |
( |
float |
in_concentration | ) |
|
Sets the concentration for this SpotlightKey. The concentration defines the rate at which light intensity decreases with increasing angular distance from the light direction vector. This effect works in addition to the decrease that occurs between the inner and outer cones.
- Parameters
-
in_concentration | The concentration for the SpotlightKey. This value must be non-negative. A value of 0.0f defines no intensity decrease (besides that between the inner and outer cone), and larger values will concentrate intensity closer to the light direction vector. |
- Returns
- A reference to this SpotlightKey.
◆ SetInnerCone()
Sets the size of the inner cone for this SpotlightKey. The inner cone defines the conic region inside the conic region defined by the outer cone at which the spotlight intensity will decrease linearly to zero at the outer cone's edge. As such, the size of the inner cone should be no larger than the outer cone.
- Parameters
-
- Returns
- A reference to this SpotlightKey.
◆ SetOuterCone()
Sets the size of the outer cone for this SpotlightKey. The outer cone defines the conic region inside of which surfaces will be illuminated by this spotlight. Any surface outside this conic region will not be illuminated by this spotlight.
- Parameters
-
- Returns
- A reference to this SpotlightKey.
◆ SetPosition()
Sets the position of the light source for this SpotlightKey.
- Parameters
-
in_position | The position of the light source for this SpotlightKey. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
- Returns
- A reference to this SpotlightKey.
- See also
- SetCameraRelative
◆ SetTarget()
Sets the target coordinate towards which the light source points for this SpotlightKey.
- Parameters
-
in_target | The target coordinate towards which the light source points for this SpotlightKey. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
- Returns
- A reference to this SpotlightKey.
- See also
- SetCameraRelative
◆ Show()
void HPS::SpotlightKey::Show |
( |
SpotlightKit & |
out_kit | ) |
const |
Copy the contents of this SpotlightKey into the specified kit.
- Parameters
-
out_kit | The kit to populate with the contents of this SpotlightKey. |
◆ ShowCameraRelative()
bool HPS::SpotlightKey::ShowCameraRelative |
( |
bool & |
out_state | ) |
const |
Shows whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space.
- Parameters
-
out_state | Whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space. |
- Returns
- true if a camera-relative setting was set, false otherwise.
◆ ShowColor()
bool HPS::SpotlightKey::ShowColor |
( |
Material::Type & |
out_type, |
|
|
RGBAColor & |
out_rgba_color, |
|
|
float & |
out_index |
|
) |
| const |
Shows the color for this SpotlightKey.
- Parameters
-
- Returns
- true if a color was set, false otherwise.
◆ ShowConcentration()
bool HPS::SpotlightKey::ShowConcentration |
( |
float & |
out_concentration | ) |
const |
Shows the concentration for this SpotlightKey.
- Parameters
-
- Returns
- true if a concentration was set, false otherwise.
◆ ShowInnerCone()
Shows the inner cone for this SpotlightKey.
- Parameters
-
out_size | The size of the inner cone for this SpotlightKey. |
out_units | The units for the size of the inner cone for this SpotlightKey. |
- Returns
- true if an inner cone was set, false otherwise.
◆ ShowOuterCone()
Shows the outer cone for this SpotlightKey.
- Parameters
-
out_size | The size of the outer cone for this SpotlightKey. |
out_units | The units for the size of the outer cone for this SpotlightKey. |
- Returns
- true if an outer cone was set, false otherwise.
◆ ShowPosition()
bool HPS::SpotlightKey::ShowPosition |
( |
HPS::Point & |
out_position | ) |
const |
Shows the position of the light source for this SpotlightKey.
- Parameters
-
out_position | The position of the light source for this SpotlightKey. |
- Returns
- true if a light source position was set, false otherwise.
◆ ShowTarget()
bool HPS::SpotlightKey::ShowTarget |
( |
HPS::Point & |
out_target | ) |
const |
Shows the target coordinate towards which the light source points for this SpotlightKey.
- Parameters
-
out_target | The target coordinate towards which the light source points for this SpotlightKey. |
- Returns
- true if a target was set, false otherwise.
◆ UnsetColor()
The documentation for this class was generated from the following file: