
Public Member Functions | |
void | Consume (HPS.DistantLightKit in_kit) |
override void | Dispose () |
DistantLightKey () | |
DistantLightKey (HPS.Key in_that) | |
DistantLightKey (HPS.DistantLightKey in_that) | |
override HPS.Type | ObjectType () |
void | Set (HPS.DistantLightKit in_kit) |
HPS.DistantLightKey | SetCameraRelative (bool in_state) |
HPS.DistantLightKey | SetColor (HPS.RGBAColor in_rgba_color) |
HPS.DistantLightKey | SetColorByIndex (float in_index) |
HPS.DistantLightKey | SetDirection (HPS.Vector in_vector) |
void | Show (out HPS.DistantLightKit out_kit) |
bool | ShowCameraRelative (out bool out_state) |
bool | ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index) |
bool | ShowDirection (out HPS.Vector out_vector) |
HPS.DistantLightKey | UnsetColor () |
![]() | |
override void | Dispose () |
GeometryKey () | |
GeometryKey (HPS.Key in_that) | |
GeometryKey (HPS.GeometryKey in_that) | |
override HPS.Type | ObjectType () |
HPS.GeometryKey | SetPriority (int in_priority) |
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
bool | ShowBounding (out HPS.BoundingKit out_kit) |
bool | ShowPriority (out int out_priority) |
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
ulong | ShowUserDataCount () |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
HPS.GeometryKey | UnsetAllUserData () |
HPS.GeometryKey | UnsetPriority () |
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
![]() | |
virtual void | Assign (HPS.Key in_that) |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
void | Delete () |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Key in_that) |
ulong | GetHash () |
override int | GetHashCode () |
bool | HasOwner () |
Key () | |
Key (HPS.Key in_that) | |
Key (HPS.Control in_control) | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
override HPS.Type | ObjectType () |
HPS.SegmentKey | Owner () |
HPS.SegmentKey | Up () |
![]() | |
virtual bool | Empty () |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
bool | HasType (HPS.Type in_mask) |
Object (HPS.Object that) | |
virtual void | Reset () |
virtual HPS.Type | Type () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The DistantLightKey class is a smart pointer to a database object. It is a handle to a distant light inserted via SegmentKey.InsertDistantLight.
Constructor & Destructor Documentation
◆ DistantLightKey() [1/3]
|
inline |
The default constructor creates an uninitialized DistantLightKey object. The Type() function will return Type.None.
◆ DistantLightKey() [2/3]
|
inline |
This constructor creates a DistantLightKey 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 DistantLight key. Otherwise the copy will fail and the resulting DistantLightKey will be invalid.
◆ DistantLightKey() [3/3]
|
inline |
The copy constructor creates a DistantLightKey object that shares the underlying smart-pointer of the source DistantLightKey.
- Parameters
-
in_that The source DistantLightKey to copy.
Member Function Documentation
◆ Consume()
|
inline |
Completely replaces all settings on this DistantLightKey with those set on the specified kit and resets the kit.
- Parameters
-
in_kit The kit from which to get the settings to replace on this DistantLightKey.
◆ ObjectType()
|
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.Object.
◆ Set()
|
inline |
Replace those settings on this DistantLightKey with those set on the specified kit.
- Parameters
-
in_kit The kit from which to get the settings to replace on this DistantLightKey.
◆ SetCameraRelative()
|
inline |
Sets the camera-relative setting for this DistantLightKey.
- Parameters
-
in_state Whether the direction of this DistantLightKey is treated as being in object space or camera-relative space.
- Returns
- A reference to this DistantLightKey.
- See also
- SetDirection
◆ SetColor()
|
inline |
Sets the RGBA color to use for this DistantLightKey.
- Parameters
-
in_rgba_color The RGBA color to use for this DistantLightKey.
- Returns
- A reference to this DistantLightKey.
◆ SetColorByIndex()
|
inline |
Sets the color index to use for this DistantLightKey.
- Parameters
-
in_index The color index to use for this DistantLightKey.
- Returns
- A reference to this DistantLightKey.
◆ SetDirection()
|
inline |
Sets the direction in which this DistantLightKey lies. The rays emitted by this light will travel in the opposite direction of this vector.
- Parameters
-
in_vector The direction in which this DistantLightKey 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 DistantLightKey.
- See also
- SetCameraRelative
◆ Show()
|
inline |
Copy the contents of this DistantLightKey into the specified kit.
- Parameters
-
out_kit The kit to populate with the contents of this DistantLightKey.
◆ ShowCameraRelative()
|
inline |
Shows the camera-relative setting for this DistantLightKey.
- Parameters
-
out_state Whether the direction of this DistantLightKey is treated as being in object space or camera-relative space.
- Returns
- true if a camera-relative setting was specified, false otherwise.
◆ ShowColor()
|
inline |
Shows the color for this DistantLightKey.
- 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.
◆ ShowDirection()
|
inline |
Shows the direction in which this DistantLightKey lies.
- Parameters
-
out_vector The direction in which this DistantLightKey lies.
- Returns
- true if a direction was set, false otherwise.
◆ UnsetColor()
|
inline |
Removes the color (RGBA or material index) set on this DistantLightKey.
- Returns
- A reference to this DistantLightKey.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.DistantLightKey.cs