REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Consume (SpotlightKit &in_kit) |
bool | Empty () const |
bool | Equals (SpotlightKit const &in_kit) const |
Type | ObjectType () const |
bool | operator!= (SpotlightKit const &in_kit) const |
SpotlightKit & | operator= (SpotlightKit &&in_that) |
SpotlightKit & | operator= (SpotlightKit const &in_kit) |
bool | operator== (SpotlightKit const &in_kit) const |
void | Set (SpotlightKit const &in_kit) |
SpotlightKit & | SetCameraRelative (bool in_state) |
SpotlightKit & | SetColor (RGBAColor const &in_rgba_color) |
SpotlightKit & | SetColorByIndex (float in_index) |
SpotlightKit & | SetConcentration (float in_concentration) |
SpotlightKit & | SetInnerCone (float in_size, Spotlight::InnerConeUnits in_units=Spotlight::InnerConeUnits::Percent) |
SpotlightKit & | SetOuterCone (float in_size, Spotlight::OuterConeUnits in_units=Spotlight::OuterConeUnits::Degrees) |
SpotlightKit & | SetPosition (Point const &in_position) |
SpotlightKit & | SetPriority (int in_priority) |
SpotlightKit & | SetTarget (Point const &in_target) |
SpotlightKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
SpotlightKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
SpotlightKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
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, Spotlight::InnerConeUnits &out_units) const |
bool | ShowOuterCone (float &out_size, Spotlight::OuterConeUnits &out_units) const |
bool | ShowPosition (Point &out_position) const |
bool | ShowPriority (int &out_priority) const |
bool | ShowTarget (Point &out_target) 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 |
SpotlightKit () | |
SpotlightKit (SpotlightKit const &in_kit) | |
SpotlightKit (SpotlightKit &&in_that) | |
SpotlightKit & | UnsetAllUserData () |
SpotlightKit & | UnsetCameraRelative () |
SpotlightKit & | UnsetColor () |
SpotlightKit & | UnsetConcentration () |
SpotlightKit & | UnsetEverything () |
SpotlightKit & | UnsetInnerCone () |
SpotlightKit & | UnsetOuterCone () |
SpotlightKit & | UnsetPosition () |
SpotlightKit & | UnsetPriority () |
SpotlightKit & | UnsetTarget () |
SpotlightKit & | UnsetUserData (intptr_t in_index) |
SpotlightKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
SpotlightKit & | UnsetUserData (IntPtrTArray const &in_indices) |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Static Public Member Functions | |
static SpotlightKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The SpotlightKit class is a user space object. It is the kit counterpart to a SpotlightKey. Note that spotlights are not hardware accelerated in Visualize. If you use spotlights, Visualize will fall back to software rendering. Calling SpotlightKit::GetDefault() will return a kit with values found in this table.
SpotlightKit::SpotlightKit | ( | ) |
The default constructor creates an empty SpotlightKit object.
SpotlightKit::SpotlightKit | ( | SpotlightKit const & | in_kit | ) |
The copy constructor creates a new SpotlightKit object that contains the same settings as the source SpotlightKit.
in_kit | The source SpotlightKit to copy. |
SpotlightKit::SpotlightKit | ( | SpotlightKit && | in_that | ) |
The move constructor creates a SpotlightKit by transferring the underlying impl of the rvalue reference to this SpotlightKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a SpotlightKit to take the impl from. |
void SpotlightKit::Consume | ( | SpotlightKit & | in_kit | ) |
Copies the source SpotlightKit into this SpotlightKit and resets the source kit.
in_kit | The source SpotlightKit to consume. |
|
virtual |
Indicates whether this SpotlightKit has any values set on it.
Reimplemented from Object.
bool SpotlightKit::Equals | ( | SpotlightKit const & | in_kit | ) | const |
Check if the source SpotlightKit is equivalent to this SpotlightKit.
in_kit | The source SpotlightKit to compare to this SpotlightKit. |
|
static |
Creates a SpotlightKit 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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool SpotlightKit::operator!= | ( | SpotlightKit const & | in_kit | ) | const |
Check if the source SpotlightKit is not equivalent to this SpotlightKit.
in_kit | The source SpotlightKit to compare to this SpotlightKit. |
SpotlightKit& SpotlightKit::operator= | ( | SpotlightKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SpotlightKit thereby avoiding a copy.
in_that | An rvalue reference to a SpotlightKit to take the impl from. |
SpotlightKit& SpotlightKit::operator= | ( | SpotlightKit const & | in_kit | ) |
Copies the source SpotlightKit into this SpotlightKit.
in_kit | The source SpotlightKit to copy. |
bool SpotlightKit::operator== | ( | SpotlightKit const & | in_kit | ) | const |
Check if the source SpotlightKit is equivalent to this SpotlightKit.
in_kit | The source SpotlightKit to compare to this SpotlightKit. |
void SpotlightKit::Set | ( | SpotlightKit const & | in_kit | ) |
Copies the source SpotlightKit into this SpotlightKit.
in_kit | The source SpotlightKit to copy. |
SpotlightKit& SpotlightKit::SetCameraRelative | ( | bool | in_state | ) |
Sets the camera-relative setting for this SpotlightKit. This defines what the implied units of the target and position will be.
in_state | Whether the coordinates of the position and target for this SpotlightKit are treated as being in object space or camera-relative space. |
SpotlightKit& SpotlightKit::SetColor | ( | RGBAColor const & | in_rgba_color | ) |
Sets the RGBA color to use for this SpotlightKit.
in_rgba_color | The RGBA color to use for this SpotlightKit. |
SpotlightKit& SpotlightKit::SetColorByIndex | ( | float | in_index | ) |
Sets the color index to use for this SpotlightKit.
in_index | The color index to use for this SpotlightKit. |
SpotlightKit& SpotlightKit::SetConcentration | ( | float | in_concentration | ) |
Sets the concentration for this SpotlightKit. 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.
in_concentration | The concentration for the SpotlightKit. 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. |
SpotlightKit& SpotlightKit::SetInnerCone | ( | float | in_size, |
Spotlight::InnerConeUnits | in_units = Spotlight::InnerConeUnits::Percent |
||
) |
Sets the size of the inner cone for this SpotlightKit. 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.
in_size | The size of the inner cone for this SpotlightKit. The interpretation of the value and its valid range depends on the units argument. |
in_units | The units for the size of the inner cone for this SpotlightKit. Defaults to Spotlight::InnerConeUnits::Percent. |
SpotlightKit& SpotlightKit::SetOuterCone | ( | float | in_size, |
Spotlight::OuterConeUnits | in_units = Spotlight::OuterConeUnits::Degrees |
||
) |
Sets the size of the outer cone for this SpotlightKit. 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.
in_size | The size of the outer cone for this SpotlightKit. The interpretation of the value and its valid range depends on the units argument. |
in_units | The units for the size of the outer cone for this SpotlightKit. Defaults to Spotlight::OuterConeUnits::Degrees. |
SpotlightKit& SpotlightKit::SetPosition | ( | Point const & | in_position | ) |
Sets the position of the light source for this SpotlightKit.
in_position | The position of the light source for this SpotlightKit. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
SpotlightKit& SpotlightKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the SpotlightKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SpotlightKit& SpotlightKit::SetTarget | ( | Point const & | in_target | ) |
Sets the target coordinate towards which the light source points for this SpotlightKit.
in_target | The target coordinate towards which the light source points for this SpotlightKit. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
SpotlightKit& SpotlightKit::SetUserData | ( | intptr_t | in_index, |
size_t | in_bytes, | ||
byte const | in_data[] | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_bytes | The number of bytes of user data to set. |
in_data | The bytes of user data to set. |
SpotlightKit& SpotlightKit::SetUserData | ( | intptr_t | in_index, |
ByteArray const & | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
SpotlightKit& SpotlightKit::SetUserData | ( | IntPtrTArray const & | in_indices, |
ByteArrayArray const & | in_data | ||
) |
Sets user data on this kit.
out_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
void SpotlightKit::Show | ( | SpotlightKit & | out_kit | ) | const |
Copies this SpotlightKit into the given SpotlightKit.
out_kit | The SpotlightKit to populate with the contents of this SpotlightKit. |
bool SpotlightKit::ShowCameraRelative | ( | bool & | out_state | ) | const |
Shows the camera-relative setting for this SpotlightKit.
out_state | Whether the coordinates of the position and target for this SpotlightKit are treated as being in object space or camera-relative space. |
bool SpotlightKit::ShowColor | ( | Material::Type & | out_type, |
RGBAColor & | out_rgba_color, | ||
float & | out_index | ||
) | const |
Shows the color for this SpotlightKit.
out_type | The type of color for the spotlight. |
out_rgba_color | The RGBA color for the spotlight. This is only valid if out_type is Material::Type::ExplicitRGBAColor. |
out_index | The material index for the spotlight. This is only valid if out_type is Material::Type::MaterialIndex. |
bool SpotlightKit::ShowConcentration | ( | float & | out_concentration | ) | const |
Shows the concentration for this SpotlightKit.
out_concentration | The concentration for this SpotlightKit. |
bool SpotlightKit::ShowInnerCone | ( | float & | out_size, |
Spotlight::InnerConeUnits & | out_units | ||
) | const |
Shows the inner cone for this SpotlightKit.
out_size | The size of the inner cone for this SpotlightKit. |
out_units | The units for the size of the inner cone for this SpotlightKit. |
bool SpotlightKit::ShowOuterCone | ( | float & | out_size, |
Spotlight::OuterConeUnits & | out_units | ||
) | const |
Shows the outer cone for this SpotlightKit.
out_size | The size of the outer cone for this SpotlightKit. |
out_units | The units for the size of the outer cone for this SpotlightKit. |
bool SpotlightKit::ShowPosition | ( | Point & | out_position | ) | const |
Shows the position of the light source for this SpotlightKit.
out_position | The position of the light source for this SpotlightKit. |
bool SpotlightKit::ShowPriority | ( | int & | out_priority | ) | const |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool SpotlightKit::ShowTarget | ( | Point & | out_target | ) | const |
Shows the target coordinate towards which the light source points for this SpotlightKit.
out_target | The target coordinate towards which the light source points for this SpotlightKit. |
bool SpotlightKit::ShowUserData | ( | intptr_t | in_index, |
ByteArray & | out_data | ||
) | const |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool SpotlightKit::ShowUserData | ( | IntPtrTArray & | out_indices, |
ByteArrayArray & | out_data | ||
) | const |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
in_data | An array of all user data set on this kit. |
size_t SpotlightKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool SpotlightKit::ShowUserDataIndices | ( | IntPtrTArray & | out_indices | ) | const |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
SpotlightKit& SpotlightKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
SpotlightKit& SpotlightKit::UnsetCameraRelative | ( | ) |
Removes the camera-relative setting for this SpotlightKit.
SpotlightKit& SpotlightKit::UnsetColor | ( | ) |
Removes the color (RGBA or material index) for this SpotlightKit.
SpotlightKit& SpotlightKit::UnsetConcentration | ( | ) |
Removes the concentration for this SpotlightKit.
SpotlightKit& SpotlightKit::UnsetEverything | ( | ) |
Removes all settings from the SpotlightKit.
SpotlightKit& SpotlightKit::UnsetInnerCone | ( | ) |
Removes the inner-cone size specification for this SpotlightKit.
SpotlightKit& SpotlightKit::UnsetOuterCone | ( | ) |
Removes the outer-cone size specification for this SpotlightKit.
SpotlightKit& SpotlightKit::UnsetPosition | ( | ) |
Removes the light source position for this SpotlightKit.
SpotlightKit& SpotlightKit::UnsetPriority | ( | ) |
Removes the drawing priority setting.
SpotlightKit& SpotlightKit::UnsetTarget | ( | ) |
Removes the target coordinate towards which the light source points for this SpotlightKit.
SpotlightKit& SpotlightKit::UnsetUserData | ( | intptr_t | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
SpotlightKit& SpotlightKit::UnsetUserData | ( | size_t | in_count, |
intptr_t const | in_indices[] | ||
) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |
SpotlightKit& SpotlightKit::UnsetUserData | ( | IntPtrTArray const & | in_indices | ) |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |