REFERENCE MANUAL
The SpotlightKit class is a user space object. More...
Public Member Functions | |
void | Consume (HPS.SpotlightKit in_kit) |
Copies the source SpotlightKit into this SpotlightKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this SpotlightKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SpotlightKit in_kit) |
Check if the source SpotlightKit is equivalent to this SpotlightKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.SpotlightKit in_kit) |
Copies the source SpotlightKit into this SpotlightKit. More... | |
HPS.SpotlightKit | SetCameraRelative (bool in_state) |
Sets the camera-relative setting for this SpotlightKit. More... | |
HPS.SpotlightKit | SetColor (HPS.RGBAColor in_rgba_color) |
Sets the RGBA color to use for this SpotlightKit. More... | |
HPS.SpotlightKit | SetColorByIndex (float in_index) |
Sets the color index to use for this SpotlightKit. More... | |
HPS.SpotlightKit | SetConcentration (float in_concentration) |
Sets the concentration for this SpotlightKit. More... | |
HPS.SpotlightKit | SetInnerCone (float in_size, HPS.Spotlight.InnerConeUnits in_units) |
Sets the size of the inner cone for this SpotlightKit. More... | |
HPS.SpotlightKit | SetInnerCone (float in_size) |
Sets the size of the inner cone for this SpotlightKit. More... | |
HPS.SpotlightKit | SetOuterCone (float in_size, HPS.Spotlight.OuterConeUnits in_units) |
Sets the size of the outer cone for this SpotlightKit. More... | |
HPS.SpotlightKit | SetOuterCone (float in_size) |
Sets the size of the outer cone for this SpotlightKit. More... | |
HPS.SpotlightKit | SetPosition (HPS.Point in_position) |
Sets the position of the light source for this SpotlightKit. More... | |
HPS.SpotlightKit | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the SpotlightKit. More... | |
HPS.SpotlightKit | SetTarget (HPS.Point in_target) |
Sets the target coordinate towards which the light source points for this SpotlightKit. More... | |
HPS.SpotlightKit | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.SpotlightKit | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this kit. More... | |
HPS.SpotlightKit | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this kit. More... | |
void | Show (out HPS.SpotlightKit out_kit) |
Copies this SpotlightKit into the given SpotlightKit. More... | |
bool | ShowCameraRelative (out bool out_state) |
Shows the camera-relative setting for this SpotlightKit. More... | |
bool | ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index) |
Shows the color for this SpotlightKit. More... | |
bool | ShowConcentration (out float out_concentration) |
Shows the concentration for this SpotlightKit. More... | |
bool | ShowInnerCone (out float out_size, out HPS.Spotlight.InnerConeUnits out_units) |
Shows the inner cone for this SpotlightKit. More... | |
bool | ShowOuterCone (out float out_size, out HPS.Spotlight.OuterConeUnits out_units) |
Shows the outer cone for this SpotlightKit. More... | |
bool | ShowPosition (out HPS.Point out_position) |
Shows the position of the light source for this SpotlightKit. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
bool | ShowTarget (out HPS.Point out_target) |
Shows the target coordinate towards which the light source points for this SpotlightKit. 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... | |
SpotlightKit () | |
The default constructor creates an empty SpotlightKit object. More... | |
SpotlightKit (HPS.SpotlightKit in_kit) | |
The copy constructor creates a new SpotlightKit object that contains the same settings as the source SpotlightKit. More... | |
HPS.SpotlightKit | UnsetAllUserData () |
Removes all user data from this kit. More... | |
HPS.SpotlightKit | UnsetCameraRelative () |
Removes the camera-relative setting for this SpotlightKit. More... | |
HPS.SpotlightKit | UnsetColor () |
Removes the color (RGBA or material index) for this SpotlightKit. More... | |
HPS.SpotlightKit | UnsetConcentration () |
Removes the concentration for this SpotlightKit. More... | |
HPS.SpotlightKit | UnsetEverything () |
Removes all settings from the SpotlightKit. More... | |
HPS.SpotlightKit | UnsetInnerCone () |
Removes the inner-cone size specification for this SpotlightKit. More... | |
HPS.SpotlightKit | UnsetOuterCone () |
Removes the outer-cone size specification for this SpotlightKit. More... | |
HPS.SpotlightKit | UnsetPosition () |
Removes the light source position for this SpotlightKit. More... | |
HPS.SpotlightKit | UnsetPriority () |
Removes the drawing priority setting. More... | |
HPS.SpotlightKit | UnsetTarget () |
Removes the target coordinate towards which the light source points for this SpotlightKit. More... | |
HPS.SpotlightKit | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this kit. More... | |
HPS.SpotlightKit | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this kit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.SpotlightKit | GetDefault () |
Creates a SpotlightKit which contains the default settings. More... | |
static bool | operator!= (HPS.SpotlightKit a, HPS.SpotlightKit b) |
static bool | operator== (HPS.SpotlightKit a, HPS.SpotlightKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The SpotlightKit class is a user space object.
It is the kit counterpart to a SpotlightKey. Note that spotlights are not hardware accelerated in Visualize. If you use spotlights, Visualize will fall back to software rendering. Calling SpotlightKit::GetDefault() will return a kit with values found in this table.
HPS.SpotlightKit.SpotlightKit | ( | ) |
The default constructor creates an empty SpotlightKit object.
HPS.SpotlightKit.SpotlightKit | ( | HPS.SpotlightKit | in_kit | ) |
The copy constructor creates a new SpotlightKit object that contains the same settings as the source SpotlightKit.
in_kit | The source <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref> to copy. |
void HPS.SpotlightKit.Consume | ( | HPS.SpotlightKit | in_kit | ) |
Copies the source SpotlightKit into this SpotlightKit and resets the source kit.
in_kit | The source <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref> to consume. |
|
virtual |
Indicates whether this SpotlightKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.SpotlightKit.Equals | ( | HPS.SpotlightKit | in_kit | ) |
Check if the source SpotlightKit is equivalent to this SpotlightKit.
in_kit | The source <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref> to compare to this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
|
static |
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.SpotlightKit.Set | ( | HPS.SpotlightKit | in_kit | ) |
Copies the source SpotlightKit into this SpotlightKit.
in_kit | The source <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref> to copy. |
HPS.SpotlightKit HPS.SpotlightKit.SetCameraRelative | ( | bool | in_state | ) |
Sets the camera-relative setting for this SpotlightKit.
This defines what the implied units of the target and position will be.
in_state | Whether the coordinates of the position and target for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref> are treated as being in object space or camera-relative space. |
SetPosition
SetTarget
HPS.SpotlightKit HPS.SpotlightKit.SetColor | ( | HPS.RGBAColor | in_rgba_color | ) |
Sets the RGBA color to use for this SpotlightKit.
in_rgba_color | The RGBA color to use for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
HPS.SpotlightKit HPS.SpotlightKit.SetColorByIndex | ( | float | in_index | ) |
Sets the color index to use for this SpotlightKit.
in_index | The color index to use for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
HPS.SpotlightKit HPS.SpotlightKit.SetConcentration | ( | float | in_concentration | ) |
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.
in_concentration | The concentration for the <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. 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. |
HPS.SpotlightKit HPS.SpotlightKit.SetInnerCone | ( | float | in_size, |
HPS.Spotlight.InnerConeUnits | in_units | ||
) |
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.
in_size | The size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. 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 <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. Defaults to <ref refid="class_h_p_s_1_1_spotlight_1ab5c133cf880f3bc99af7a656bee6c17daadaaee4b22041c27198d410c68d952c9" kindref="member">Spotlight::InnerConeUnits::Percent</ref>. |
HPS.SpotlightKit HPS.SpotlightKit.SetInnerCone | ( | float | in_size | ) |
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.
in_size | The size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. The interpretation of the value and its valid range depends on the units argument. |
HPS.SpotlightKit HPS.SpotlightKit.SetOuterCone | ( | float | in_size, |
HPS.Spotlight.OuterConeUnits | in_units | ||
) |
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.
in_size | The size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. 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 <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. Defaults to <ref refid="class_h_p_s_1_1_spotlight_1a6caa7c688111e49f76955e28e4797fd5a9ef125630442bb42e2e367e0cf70d892" kindref="member">Spotlight::OuterConeUnits::Degrees</ref>. |
HPS.SpotlightKit HPS.SpotlightKit.SetOuterCone | ( | float | in_size | ) |
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.
in_size | The size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. The interpretation of the value and its valid range depends on the units argument. |
HPS.SpotlightKit HPS.SpotlightKit.SetPosition | ( | HPS.Point | in_position | ) |
Sets the position of the light source for this SpotlightKit.
in_position | The position of the light source for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
SetCameraRelative
HPS.SpotlightKit HPS.SpotlightKit.SetPriority | ( | int | in_priority | ) |
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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SubwindowKit::SetPriority()
HPS.SpotlightKit HPS.SpotlightKit.SetTarget | ( | HPS.Point | in_target | ) |
Sets the target coordinate towards which the light source points for this SpotlightKit.
in_target | The target coordinate towards which the light source points for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. The point will either be treated as being in object space or in camera-relative units depending on the setting passed to SetCameraRelative. |
SetCameraRelative
HPS.SpotlightKit HPS.SpotlightKit.SetUserData | ( | IntPtr | in_index, |
ulong | in_bytes, | ||
byte[] | in_data | ||
) |
Sets user data on this kit.
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. |
HPS.SpotlightKit HPS.SpotlightKit.SetUserData | ( | IntPtr | in_index, |
byte[] | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
HPS.SpotlightKit HPS.SpotlightKit.SetUserData | ( | IntPtr[] | in_indices, |
byte | in_data[][] | ||
) |
Sets user data on this kit.
in_data | An array of bytes of user data to set. |
void HPS.SpotlightKit.Show | ( | out HPS.SpotlightKit | out_kit | ) |
Copies this SpotlightKit into the given SpotlightKit.
out_kit | The <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
bool HPS.SpotlightKit.ShowCameraRelative | ( | out bool | out_state | ) |
Shows the camera-relative setting for this SpotlightKit.
out_state | Whether the coordinates of the position and target for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref> are treated as being in object space or camera-relative space. |
bool HPS.SpotlightKit.ShowColor | ( | out HPS.Material.Type | out_type, |
out HPS.RGBAColor | out_rgba_color, | ||
out float | out_index | ||
) |
Shows the color for this SpotlightKit.
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 <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da5769501214f669cb063fd410bb5eb822" kindref="member">Material::Type::ExplicitRGBAColor</ref>. |
out_index | The material index for the spotlight. This is only valid if out_type is <ref refid="class_h_p_s_1_1_material_1a2ec9b893c8c5b2e37ec82aff0c82a18da3e21f60632b7774f92151ddc6b0c64b5" kindref="member">Material::Type::MaterialIndex</ref>. |
bool HPS.SpotlightKit.ShowConcentration | ( | out float | out_concentration | ) |
Shows the concentration for this SpotlightKit.
out_concentration | The concentration for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
bool HPS.SpotlightKit.ShowInnerCone | ( | out float | out_size, |
out HPS.Spotlight.InnerConeUnits | out_units | ||
) |
Shows the inner cone for this SpotlightKit.
out_size | The size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
out_units | The units for the size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
bool HPS.SpotlightKit.ShowOuterCone | ( | out float | out_size, |
out HPS.Spotlight.OuterConeUnits | out_units | ||
) |
Shows the outer cone for this SpotlightKit.
out_size | The size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
out_units | The units for the size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
bool HPS.SpotlightKit.ShowPosition | ( | out HPS.Point | out_position | ) |
Shows the position of the light source for this SpotlightKit.
out_position | The position of the light source for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
bool HPS.SpotlightKit.ShowPriority | ( | out int | out_priority | ) |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS.SpotlightKit.ShowTarget | ( | out HPS.Point | out_target | ) |
Shows the target coordinate towards which the light source points for this SpotlightKit.
out_target | The target coordinate towards which the light source points for this <ref refid="class_h_p_s_1_1_spotlight_kit" kindref="compound">SpotlightKit</ref>. |
bool HPS.SpotlightKit.ShowUserData | ( | IntPtr | in_index, |
out byte[] | out_data | ||
) |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool HPS.SpotlightKit.ShowUserData | ( | out IntPtr[] | out_indices, |
out byte | out_data[][] | ||
) |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
ulong HPS.SpotlightKit.ShowUserDataCount | ( | ) |
Get the number of user data indices set on this kit.
bool HPS.SpotlightKit.ShowUserDataIndices | ( | out IntPtr[] | out_indices | ) |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
HPS.SpotlightKit HPS.SpotlightKit.UnsetAllUserData | ( | ) |
Removes all user data from this kit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetCameraRelative | ( | ) |
Removes the camera-relative setting for this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetColor | ( | ) |
Removes the color (RGBA or material index) for this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetConcentration | ( | ) |
Removes the concentration for this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetEverything | ( | ) |
Removes all settings from the SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetInnerCone | ( | ) |
Removes the inner-cone size specification for this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetOuterCone | ( | ) |
Removes the outer-cone size specification for this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetPosition | ( | ) |
Removes the light source position for this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetPriority | ( | ) |
Removes the drawing priority setting.
HPS.SpotlightKit HPS.SpotlightKit.UnsetTarget | ( | ) |
Removes the target coordinate towards which the light source points for this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetUserData | ( | IntPtr | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
HPS.SpotlightKit HPS.SpotlightKit.UnsetUserData | ( | IntPtr[] | in_indices | ) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |