
Public Member Functions | |
void | Consume (HPS.DistantLightKit in_kit) |
Copies the source DistantLightKit into this DistantLightKit and resets the source kit. More... | |
override void | Dispose () |
DistantLightKit () | |
The default constructor creates an empty DistantLightKit object. More... | |
DistantLightKit (HPS.DistantLightKit in_kit) | |
The copy constructor creates a new DistantLightKit object that contains the same settings as the source DistantLightKit. More... | |
override bool | Empty () |
Indicates whether this DistantLightKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.DistantLightKit in_kit) |
Check if the source DistantLightKit is equivalent to this DistantLightKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.DistantLightKit in_kit) |
Copies the source DistantLightKit into this DistantLightKit. More... | |
HPS.DistantLightKit | SetCameraRelative (bool in_state) |
Sets the camera-relative setting for this DistantLightKit. More... | |
HPS.DistantLightKit | SetColor (HPS.RGBAColor in_rgba_color) |
Sets the RGBA color to use for this DistantLightKit. More... | |
HPS.DistantLightKit | SetColorByIndex (float in_index) |
Sets the color index to use for this DistantLightKit. More... | |
HPS.DistantLightKit | SetDirection (HPS.Vector in_vector) |
Sets the direction in which this DistantLightKit lies. The rays emitted by this light will travel in the opposite direction of this vector. More... | |
HPS.DistantLightKit | SetPriority (int in_priority) |
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. More... | |
HPS.DistantLightKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.DistantLightKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.DistantLightKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.DistantLightKit out_kit) |
Copies this DistantLightKit into the given DistantLightKit. More... | |
bool | ShowCameraRelative (out bool out_state) |
Shows the camera-relative setting for this DistantLightKit. More... | |
bool | ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index) |
Shows the color for this DistantLightKit. More... | |
bool | ShowDirection (out HPS.Vector out_vector) |
Shows the direction in which this DistantLightKit lies. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority for this DistantLightKit. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this kit. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this kit. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this kit. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this kit. More... | |
HPS.DistantLightKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.DistantLightKit | UnsetCameraRelative () |
Removes the camera-relative setting on this DistantLightKit. More... | |
HPS.DistantLightKit | UnsetColor () |
Removes the color (RGBA or material index) set on this DistantLightKit. More... | |
HPS.DistantLightKit | UnsetDirection () |
Removes the direction set on this DistantLightKit. More... | |
HPS.DistantLightKit | UnsetEverything () |
Removes all settings from the DistantLightKit. More... | |
HPS.DistantLightKit | UnsetPriority () |
Removes the drawing priority setting. More... | |
HPS.DistantLightKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.DistantLightKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.DistantLightKit a, HPS.DistantLightKit b) |
static bool | operator== (HPS.DistantLightKit a, HPS.DistantLightKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The DistantLightKit class is a user space object. It is a kit analog to a DistantLightKey.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty DistantLightKit object.
|
inline |
The copy constructor creates a new DistantLightKit object that contains the same settings as the source DistantLightKit.
- Parameters
-
in_kit The source DistantLightKit to copy.
Member Function Documentation
|
inline |
Copies the source DistantLightKit into this DistantLightKit and resets the source kit.
- Parameters
-
in_kit The source DistantLightKit to consume.
|
inlinevirtual |
Indicates whether this DistantLightKit has any values set on it.
- Returns
- true if no values are set on this DistantLightKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source DistantLightKit is equivalent to this DistantLightKit.
- Parameters
-
in_kit The source DistantLightKit to compare to this DistantLightKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
|
inline |
Copies the source DistantLightKit into this DistantLightKit.
- Parameters
-
in_kit The source DistantLightKit to copy.
|
inline |
Sets the camera-relative setting for this DistantLightKit.
- Parameters
-
in_state Whether the direction of this DistantLightKit is treated as being in object space or camera-relative space.
- Returns
- A reference to this DistantLightKit.
SetDirection
Default value
|
inline |
Sets the RGBA color to use for this DistantLightKit.
- Parameters
-
in_rgba_color The RGBA color to use for this DistantLightKit.
- Returns
- A reference to this DistantLightKit.
|
inline |
Sets the color index to use for this DistantLightKit.
- Parameters
-
in_index The color index to use for this DistantLightKit.
- Returns
- A reference to this DistantLightKit.
|
inline |
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.
SetCameraRelative
Default value
|
inline |
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.
SubwindowKit.SetPriority()
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Copies this DistantLightKit into the given DistantLightKit.
- Parameters
-
out_kit The DistantLightKit to populate with the contents of this DistantLightKit.
|
inline |
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.
|
inline |
Shows the color for this DistantLightKit.
- Parameters
-
out_type The type of color for the distant light. out_rgba_color The RGBA color for the distant light. This is only valid if out_type is Material.Type.RGBAColor. out_index The material index for the distant light. This is only valid if out_type is Material.Type.MaterialIndex.
- Returns
- true if a color was set, false otherwise.
|
inline |
Shows the direction in which this DistantLightKit lies.
- Parameters
-
out_vector The direction in which this DistantLightKit lies.
- Returns
- true if a direction was set, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Get the number of user data indices set on this kit.
|
inline |
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.
|
inline |
Removes all user data from this kit.
- Returns
- A reference to this kit.
|
inline |
Removes the camera-relative setting on this DistantLightKit.
- Returns
- A reference to this DistantLightKit.
|
inline |
Removes the color (RGBA or material index) set on this DistantLightKit.
- Returns
- A reference to this DistantLightKit.
|
inline |
Removes the direction set on this DistantLightKit.
- Returns
- A reference to this DistantLightKit.
|
inline |
Removes all settings from the DistantLightKit.
- Returns
- A reference to this DistantLightKit.
|
inline |
Removes the drawing priority setting.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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:
- internals/hps_core/source/cs/HPS.DistantLightKit.cs