|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
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 |
|
The DistantLightKey class is a smart pointer to a database object. It is a handle to a distant light inserted via SegmentKey.InsertDistantLight.
◆ DistantLightKey() [1/3]
HPS.DistantLightKey.DistantLightKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized DistantLightKey object. The Type() function will return Type.None.
◆ DistantLightKey() [2/3]
HPS.DistantLightKey.DistantLightKey |
( |
HPS.Key |
in_that | ) |
|
|
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]
◆ Consume()
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()
override HPS.Type HPS.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()
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()
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.
SetDirection
◆ SetColor()
◆ SetColorByIndex()
◆ SetDirection()
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.
SetCameraRelative
◆ Show()
Copy the contents of this DistantLightKey into the specified kit.
- Parameters
-
◆ ShowCameraRelative()
bool HPS.DistantLightKey.ShowCameraRelative |
( |
out bool |
out_state | ) |
|
|
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()
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()
bool HPS.DistantLightKey.ShowDirection |
( |
out HPS.Vector |
out_vector | ) |
|
|
inline |
Shows the direction in which this DistantLightKey lies.
- Parameters
-
- Returns
- true if a direction was set, false otherwise.
◆ UnsetColor()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.DistantLightKey.cs