|
void | Consume (HPS.SpotlightKit in_kit) |
|
override void | Dispose () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.SpotlightKit in_kit) |
|
HPS.SpotlightKey | SetCameraRelative (bool in_state) |
|
HPS.SpotlightKey | SetColor (HPS.RGBAColor in_rgba_color) |
|
HPS.SpotlightKey | SetColorByIndex (float in_index) |
|
HPS.SpotlightKey | SetConcentration (float in_concentration) |
|
HPS.SpotlightKey | SetInnerCone (float in_size, HPS.Spotlight.InnerConeUnits in_units) |
|
HPS.SpotlightKey | SetInnerCone (float in_size) |
|
HPS.SpotlightKey | SetOuterCone (float in_size, HPS.Spotlight.OuterConeUnits in_units) |
|
HPS.SpotlightKey | SetOuterCone (float in_size) |
|
HPS.SpotlightKey | SetPosition (HPS.Point in_position) |
|
HPS.SpotlightKey | SetTarget (HPS.Point in_target) |
|
void | Show (out HPS.SpotlightKit 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 | ShowConcentration (out float out_concentration) |
|
bool | ShowInnerCone (out float out_size, out HPS.Spotlight.InnerConeUnits out_units) |
|
bool | ShowOuterCone (out float out_size, out HPS.Spotlight.OuterConeUnits out_units) |
|
bool | ShowPosition (out HPS.Point out_position) |
|
bool | ShowTarget (out HPS.Point out_target) |
|
| SpotlightKey () |
|
| SpotlightKey (HPS.Key in_that) |
|
| SpotlightKey (HPS.SpotlightKey in_that) |
|
HPS.SpotlightKey | UnsetColor () |
|
| GeometryKey () |
|
| GeometryKey (HPS.Key in_that) |
|
| GeometryKey (HPS.GeometryKey in_that) |
|
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 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) |
|
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 () |
|
|
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 SpotlightKey class is a smart pointer to a database object. It is a handle to a spotlight inserted via SegmentKey.InsertSpotlight.
◆ SpotlightKey() [1/3]
HPS.SpotlightKey.SpotlightKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized SpotlightKey object. The Type() function will return Type.None.
◆ SpotlightKey() [2/3]
HPS.SpotlightKey.SpotlightKey |
( |
HPS.Key |
in_that | ) |
|
|
inline |
This constructor creates a SpotlightKey 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 Spotlight key. Otherwise the copy will fail and the resulting SpotlightKey will be invalid.
◆ SpotlightKey() [3/3]
The copy constructor creates a SpotlightKey object that shares the underlying smart-pointer of the source SpotlightKey.
- Parameters
-
◆ Consume()
Completely replaces all settings on this SpotlightKey with those set on the specified kit and resets the kit.InfiniteLineKey
- Parameters
-
in_kit | The kit from which to get the settings to replace on this SpotlightKey. |
◆ ObjectType()
override HPS.Type HPS.SpotlightKey.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.GeometryKey.
◆ Set()
Replace those settings on this SpotlightKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this SpotlightKey. |
◆ SetCameraRelative()
Sets whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space.
- Parameters
-
in_state | Whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space. |
- Returns
- A reference to this SpotlightKey.
- See also
- SetPosition
-
SetTarget
◆ SetColor()
◆ SetColorByIndex()
◆ SetConcentration()
Sets the concentration for this SpotlightKey. 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.
- Parameters
-
in_concentration | The concentration for the SpotlightKey. 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. |
- Returns
- A reference to this SpotlightKey.
◆ SetInnerCone() [1/2]
Sets the size of the inner cone for this SpotlightKey. 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.
- Parameters
-
in_size | The size of the inner cone for this SpotlightKey. 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 SpotlightKey. Defaults to Spotlight.InnerConeUnits.Degrees. |
- Returns
- A reference to this SpotlightKey.
◆ SetInnerCone() [2/2]
Sets the size of the inner cone for this SpotlightKey. 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.
- Parameters
-
in_size | The size of the inner cone for this SpotlightKey. The interpretation of the value and its valid range depends on the units argument. |
- Returns
- A reference to this SpotlightKey.
◆ SetOuterCone() [1/2]
Sets the size of the outer cone for this SpotlightKey. 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.
- Parameters
-
in_size | The size of the outer cone for this SpotlightKey. 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 SpotlightKey. Defaults to Spotlight.OuterConeUnits.Degrees. |
- Returns
- A reference to this SpotlightKey.
◆ SetOuterCone() [2/2]
Sets the size of the outer cone for this SpotlightKey. 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.
- Parameters
-
in_size | The size of the outer cone for this SpotlightKey. The interpretation of the value and its valid range depends on the units argument. |
- Returns
- A reference to this SpotlightKey.
◆ SetPosition()
Sets the position of the light source for this SpotlightKey.
- Parameters
-
in_position | The position of the light source for this SpotlightKey. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
- Returns
- A reference to this SpotlightKey.
- See also
- SetCameraRelative
◆ SetTarget()
Sets the target coordinate towards which the light source points for this SpotlightKey.
- Parameters
-
in_target | The target coordinate towards which the light source points for this SpotlightKey. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
- Returns
- A reference to this SpotlightKey.
- See also
- SetCameraRelative
◆ Show()
Copy the contents of this SpotlightKey into the specified kit.
- Parameters
-
out_kit | The kit to populate with the contents of this SpotlightKey. |
◆ ShowCameraRelative()
bool HPS.SpotlightKey.ShowCameraRelative |
( |
out bool |
out_state | ) |
|
|
inline |
Shows whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space.
- Parameters
-
out_state | Whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space. |
- Returns
- true if a camera-relative setting was set, false otherwise.
◆ ShowColor()
Shows the color for this SpotlightKey.
- Parameters
-
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.RGBAColor. |
out_index | The material index for the spotlight. This is only valid if out_type is Material.Type.MaterialIndex. |
- Returns
- true if a color was set, false otherwise.
◆ ShowConcentration()
bool HPS.SpotlightKey.ShowConcentration |
( |
out float |
out_concentration | ) |
|
|
inline |
Shows the concentration for this SpotlightKey.
- Parameters
-
- Returns
- true if a concentration was set, false otherwise.
◆ ShowInnerCone()
Shows the inner cone for this SpotlightKey.
- Parameters
-
out_size | The size of the inner cone for this SpotlightKey. |
out_units | The units for the size of the inner cone for this SpotlightKey. |
- Returns
- true if an inner cone was set, false otherwise.
◆ ShowOuterCone()
Shows the outer cone for this SpotlightKey.
- Parameters
-
out_size | The size of the outer cone for this SpotlightKey. |
out_units | The units for the size of the outer cone for this SpotlightKey. |
- Returns
- true if an outer cone was set, false otherwise.
◆ ShowPosition()
bool HPS.SpotlightKey.ShowPosition |
( |
out HPS.Point |
out_position | ) |
|
|
inline |
Shows the position of the light source for this SpotlightKey.
- Parameters
-
out_position | The position of the light source for this SpotlightKey. |
- Returns
- true if a light source position was set, false otherwise.
◆ ShowTarget()
bool HPS.SpotlightKey.ShowTarget |
( |
out HPS.Point |
out_target | ) |
|
|
inline |
Shows the target coordinate towards which the light source points for this SpotlightKey.
- Parameters
-
out_target | The target coordinate towards which the light source points for this SpotlightKey. |
- Returns
- true if a target was set, false otherwise.
◆ UnsetColor()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SpotlightKey.cs