#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The DistantLightKit class is a user space object. It is a kit analog to a DistantLightKey.
HPS::DistantLightKit::DistantLightKit |
( |
| ) |
|
The move constructor creates a DistantLightKit by transferring the underlying impl of the rvalue reference to this DistantLightKit thereby avoiding a copy and allocation.
- Parameters
-
bool HPS::DistantLightKit::Empty |
( |
| ) |
const |
|
virtual |
HPS::Type HPS::DistantLightKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
bool HPS::DistantLightKit::operator!= |
( |
DistantLightKit const & |
in_kit | ) |
const |
Check if the source DistantLightKit is not equivalent to this DistantLightKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this DistantLightKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this DistantLightKit.
bool HPS::DistantLightKit::operator== |
( |
DistantLightKit const & |
in_kit | ) |
const |
Sets the direction in which this DistantLightKit lies. The rays emitted by this light will travel in the opposite direction of this vector.
- Parameters
-
in_vector | The direction in which this DistantLightKit lies. The vector will either be treated as being in object space or in camera-relative units depending on the setting passed SetCameraRelative. |
- Returns
- A reference to this DistantLightKit.
- See also
- SetCameraRelative
-
Default value
Assigns a specific drawing priority value to the DistantLightKit. It affects the order in which the contents of the owning segment are drawn if and only if the rendering algorithm is set to Priority.
- Parameters
-
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- A reference to this object.
- See also
- SubwindowKit::SetPriority()
-
SubwindowKit::SetRenderingAlgorithm()
DistantLightKit& HPS::DistantLightKit::SetUserData |
( |
intptr_t |
in_index, |
|
|
size_t |
in_bytes, |
|
|
byte const |
in_data[] |
|
) |
| |
Sets user data on this kit.
- Parameters
-
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. |
- Returns
- A reference to this kit.
DistantLightKit& HPS::DistantLightKit::SetUserData |
( |
intptr_t |
in_index, |
|
|
ByteArray const & |
in_data |
|
) |
| |
Sets user data on this kit.
- Parameters
-
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
- Returns
- A reference to this kit.
DistantLightKit& HPS::DistantLightKit::SetUserData |
( |
IntPtrTArray const & |
in_indices, |
|
|
ByteArrayArray const & |
in_data |
|
) |
| |
Sets user data on this kit.
- Parameters
-
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
- Returns
- A reference to this kit.
bool HPS::DistantLightKit::ShowCameraRelative |
( |
bool & |
out_state | ) |
const |
Shows the camera-relative setting for this DistantLightKit.
- Parameters
-
out_state | Whether the direction of this DistantLightKit is treated as being in object space or camera-relative space. |
- Returns
- true if a camera-relative setting was specified, false otherwise.
bool HPS::DistantLightKit::ShowColor |
( |
Material::Type & |
out_type, |
|
|
RGBAColor & |
out_rgba_color, |
|
|
float & |
out_index |
|
) |
| const |
Shows the color for this DistantLightKit.
- Parameters
-
- Returns
- true if a color was set, false otherwise.
bool HPS::DistantLightKit::ShowDirection |
( |
HPS::Vector & |
out_vector | ) |
const |
Shows the direction in which this DistantLightKit lies.
- Parameters
-
- Returns
- true if a direction was set, false otherwise.
bool HPS::DistantLightKit::ShowPriority |
( |
int & |
out_priority | ) |
const |
Shows the drawing priority for this DistantLightKit.
- Parameters
-
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- true if drawing priority was specified, false otherwise.
bool HPS::DistantLightKit::ShowUserData |
( |
intptr_t |
in_index, |
|
|
ByteArray & |
out_data |
|
) |
| const |
Shows the user data at a given index for this kit.
- Parameters
-
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
- Returns
- true if there is user data at the given index, false otherwise.
bool HPS::DistantLightKit::ShowUserData |
( |
IntPtrTArray & |
out_indices, |
|
|
ByteArrayArray & |
out_data |
|
) |
| const |
Shows all user data for this kit.
- Parameters
-
out_indices | An array of all user data indices set on this kit. |
out_data | An array of all user data set on this kit. |
- Returns
- true if there is user data on this kit, false otherwise.
size_t HPS::DistantLightKit::ShowUserDataCount |
( |
| ) |
const |
Get the number of user data indices set on this kit.
bool HPS::DistantLightKit::ShowUserDataIndices |
( |
IntPtrTArray & |
out_indices | ) |
const |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices | The user data indices set on this kit. |
- Returns
- The number of user data indices set on this kit.
Removes all user data from this kit.
- Returns
- A reference to this kit.
Removes the drawing priority setting.
- Returns
- A reference to this object.
Removes the user data at the given index from this kit.
- Parameters
-
in_index | The index of the user data to remove. |
- Returns
- A reference to this kit.
DistantLightKit& HPS::DistantLightKit::UnsetUserData |
( |
size_t |
in_count, |
|
|
intptr_t const |
in_indices[] |
|
) |
| |
Removes the user data at the given indices from this kit.
- Parameters
-
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |
- Returns
- A reference to this kit.
DistantLightKit& HPS::DistantLightKit::UnsetUserData |
( |
IntPtrTArray const & |
in_indices | ) |
|
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices | The indices of the user data to remove. |
- Returns
- A reference to this kit.
The documentation for this class was generated from the following file: