|
void | Consume (HPS.SpotlightKit in_kit) |
|
override void | Dispose () |
|
override bool | Empty () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.SpotlightKit in_kit) |
|
override int | GetHashCode () |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.SpotlightKit in_kit) |
|
HPS.SpotlightKit | SetCameraRelative (bool in_state) |
|
HPS.SpotlightKit | SetColor (HPS.RGBAColor in_rgba_color) |
|
HPS.SpotlightKit | SetColorByIndex (float in_index) |
|
HPS.SpotlightKit | SetConcentration (float in_concentration) |
|
HPS.SpotlightKit | SetInnerCone (float in_size, HPS.Spotlight.InnerConeUnits in_units) |
|
HPS.SpotlightKit | SetInnerCone (float in_size) |
|
HPS.SpotlightKit | SetOuterCone (float in_size, HPS.Spotlight.OuterConeUnits in_units) |
|
HPS.SpotlightKit | SetOuterCone (float in_size) |
|
HPS.SpotlightKit | SetPosition (HPS.Point in_position) |
|
HPS.SpotlightKit | SetPriority (int in_priority) |
|
HPS.SpotlightKit | SetTarget (HPS.Point in_target) |
|
HPS.SpotlightKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
|
HPS.SpotlightKit | SetUserData (IntPtr in_index, byte[] in_data) |
|
HPS.SpotlightKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
|
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 | ShowPriority (out int out_priority) |
|
bool | ShowTarget (out HPS.Point out_target) |
|
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) |
|
| SpotlightKit () |
|
| SpotlightKit (HPS.SpotlightKit in_kit) |
|
HPS.SpotlightKit | UnsetAllUserData () |
|
HPS.SpotlightKit | UnsetCameraRelative () |
|
HPS.SpotlightKit | UnsetColor () |
|
HPS.SpotlightKit | UnsetConcentration () |
|
HPS.SpotlightKit | UnsetEverything () |
|
HPS.SpotlightKit | UnsetInnerCone () |
|
HPS.SpotlightKit | UnsetOuterCone () |
|
HPS.SpotlightKit | UnsetPosition () |
|
HPS.SpotlightKit | UnsetPriority () |
|
HPS.SpotlightKit | UnsetTarget () |
|
HPS.SpotlightKit | UnsetUserData (IntPtr in_index) |
|
HPS.SpotlightKit | UnsetUserData (IntPtr[] in_indices) |
|
| Kit (HPS.Kit in_that) |
|
override HPS.Type | Type () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.SpotlightKit class is a user space object. It is the kit counterpart to a HPS.SpotlightKey. Calling HPS.SpotlightKit.GetDefault() will return a kit with values found in this table.
◆ SpotlightKit() [1/2]
HPS.SpotlightKit.SpotlightKit |
( |
| ) |
|
|
inline |
The default constructor creates an empty SpotlightKit object.
◆ SpotlightKit() [2/2]
The copy constructor creates a new SpotlightKit object that contains the same settings as the source SpotlightKit.
- Parameters
-
◆ Consume()
◆ Empty()
override bool HPS.SpotlightKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
Check if the source SpotlightKit is equivalent to this SpotlightKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
Creates a SpotlightKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A SpotlightKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.SpotlightKit.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.Kit.
◆ Set()
◆ SetCameraRelative()
Sets the camera-relative setting for this SpotlightKit. This defines what the implied units of the target and position will be.
- Parameters
-
in_state | Whether the coordinates of the position and target for this SpotlightKit are treated as being in object space or camera-relative space. |
- Returns
- A reference to this SpotlightKit.
- See also
- SetPosition
-
SetTarget
◆ SetColor()
◆ SetColorByIndex()
◆ SetConcentration()
Sets the concentration for this SpotlightKit. 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 SpotlightKit. 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 SpotlightKit.
◆ SetInnerCone() [1/2]
Sets the size of the inner cone for this SpotlightKit. 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 SpotlightKit. 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 SpotlightKit. Defaults to Spotlight.InnerConeUnits.Percent. |
- Returns
- A reference to this SpotlightKit.
◆ SetInnerCone() [2/2]
Sets the size of the inner cone for this SpotlightKit. 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 SpotlightKit. The interpretation of the value and its valid range depends on the units argument. |
- Returns
- A reference to this SpotlightKit.
◆ SetOuterCone() [1/2]
Sets the size of the outer cone for this SpotlightKit. 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 SpotlightKit. 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 SpotlightKit. Defaults to Spotlight.OuterConeUnits.Degrees. |
- Returns
- A reference to this SpotlightKit.
◆ SetOuterCone() [2/2]
Sets the size of the outer cone for this SpotlightKit. 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 SpotlightKit. The interpretation of the value and its valid range depends on the units argument. |
- Returns
- A reference to this SpotlightKit.
◆ SetPosition()
Sets the position of the light source for this SpotlightKit.
- Parameters
-
in_position | The position of the light source for this SpotlightKit. 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 SpotlightKit.
- See also
- SetCameraRelative
◆ SetPriority()
Assigns a specific drawing priority value to the SpotlightKit. It affects the order in which the contents of this 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()
◆ SetTarget()
Sets the target coordinate towards which the light source points for this SpotlightKit.
- Parameters
-
in_target | The target coordinate towards which the light source points for this SpotlightKit. 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 SpotlightKit.
- See also
- SetCameraRelative
◆ SetUserData() [1/3]
HPS.SpotlightKit HPS.SpotlightKit.SetUserData |
( |
IntPtr |
in_index, |
|
|
ulong |
in_bytes, |
|
|
byte [] |
in_data |
|
) |
| |
|
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.
◆ SetUserData() [2/3]
HPS.SpotlightKit HPS.SpotlightKit.SetUserData |
( |
IntPtr |
in_index, |
|
|
byte [] |
in_data |
|
) |
| |
|
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.
◆ SetUserData() [3/3]
HPS.SpotlightKit HPS.SpotlightKit.SetUserData |
( |
IntPtr [] |
in_indices, |
|
|
byte |
in_data[][] |
|
) |
| |
|
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.
◆ Show()
◆ ShowCameraRelative()
bool HPS.SpotlightKit.ShowCameraRelative |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the camera-relative setting for this SpotlightKit.
- Parameters
-
out_state | Whether the coordinates of the position and target for this SpotlightKit 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 SpotlightKit.
- 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.SpotlightKit.ShowConcentration |
( |
out float |
out_concentration | ) |
|
|
inline |
Shows the concentration for this SpotlightKit.
- Parameters
-
- Returns
- true if a concentration was set, false otherwise.
◆ ShowInnerCone()
Shows the inner cone for this SpotlightKit.
- Parameters
-
out_size | The size of the inner cone for this SpotlightKit. |
out_units | The units for the size of the inner cone for this SpotlightKit. |
- Returns
- true if an inner cone was set, false otherwise.
◆ ShowOuterCone()
Shows the outer cone for this SpotlightKit.
- Parameters
-
out_size | The size of the outer cone for this SpotlightKit. |
out_units | The units for the size of the outer cone for this SpotlightKit. |
- Returns
- true if an outer cone was set, false otherwise.
◆ ShowPosition()
bool HPS.SpotlightKit.ShowPosition |
( |
out HPS.Point |
out_position | ) |
|
|
inline |
Shows the position of the light source for this SpotlightKit.
- Parameters
-
out_position | The position of the light source for this SpotlightKit. |
- Returns
- true if a light source position was set, false otherwise.
◆ ShowPriority()
bool HPS.SpotlightKit.ShowPriority |
( |
out int |
out_priority | ) |
|
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
- Returns
- true if a drawing priority was specified, false otherwise.
◆ ShowTarget()
bool HPS.SpotlightKit.ShowTarget |
( |
out HPS.Point |
out_target | ) |
|
|
inline |
Shows the target coordinate towards which the light source points for this SpotlightKit.
- Parameters
-
out_target | The target coordinate towards which the light source points for this SpotlightKit. |
- Returns
- true if a target was set, false otherwise.
◆ ShowUserData() [1/2]
bool HPS.SpotlightKit.ShowUserData |
( |
IntPtr |
in_index, |
|
|
out byte [] |
out_data |
|
) |
| |
|
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.
◆ ShowUserData() [2/2]
bool HPS.SpotlightKit.ShowUserData |
( |
out IntPtr [] |
out_indices, |
|
|
out byte |
out_data[][] |
|
) |
| |
|
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.
◆ ShowUserDataCount()
ulong HPS.SpotlightKit.ShowUserDataCount |
( |
| ) |
|
|
inline |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
bool HPS.SpotlightKit.ShowUserDataIndices |
( |
out IntPtr [] |
out_indices | ) |
|
|
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.
◆ UnsetAllUserData()
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetCameraRelative()
◆ UnsetColor()
◆ UnsetConcentration()
◆ UnsetEverything()
◆ UnsetInnerCone()
◆ UnsetOuterCone()
◆ UnsetPosition()
◆ UnsetPriority()
Removes the drawing priority setting.
- Returns
- A reference to this SpotlightKit.
◆ UnsetTarget()
Removes the target coordinate towards which the light source points for this SpotlightKit.
- Returns
- A reference to this SpotlightKit.
◆ UnsetUserData() [1/2]
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.
◆ UnsetUserData() [2/2]
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.SpotlightKit.cs