REFERENCE MANUAL
The SpotlightKey class is a smart pointer to a database object. More...
Public Member Functions | |
void | Consume (HPS.SpotlightKit in_kit) |
Completely replaces all settings on this SpotlightKey with those set on the specified kit and resets the kit.InfiniteLineKey More... | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.SpotlightKit in_kit) |
Replace those settings on this SpotlightKey with those set on the specified kit. More... | |
HPS.SpotlightKey | SetCameraRelative (bool in_state) |
Sets whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space. More... | |
HPS.SpotlightKey | SetColor (HPS.RGBAColor in_rgba_color) |
Sets the RGBA color to use for this SpotlightKey. More... | |
HPS.SpotlightKey | SetColorByIndex (float in_index) |
Sets the color index to use for this SpotlightKey. More... | |
HPS.SpotlightKey | SetConcentration (float in_concentration) |
Sets the concentration for this SpotlightKey. More... | |
HPS.SpotlightKey | SetInnerCone (float in_size, HPS.Spotlight.InnerConeUnits in_units) |
Sets the size of the inner cone for this SpotlightKey. More... | |
HPS.SpotlightKey | SetInnerCone (float in_size) |
Sets the size of the inner cone for this SpotlightKey. More... | |
HPS.SpotlightKey | SetOuterCone (float in_size, HPS.Spotlight.OuterConeUnits in_units) |
Sets the size of the outer cone for this SpotlightKey. More... | |
HPS.SpotlightKey | SetOuterCone (float in_size) |
Sets the size of the outer cone for this SpotlightKey. More... | |
HPS.SpotlightKey | SetPosition (HPS.Point in_position) |
Sets the position of the light source for this SpotlightKey. More... | |
HPS.SpotlightKey | SetTarget (HPS.Point in_target) |
Sets the target coordinate towards which the light source points for this SpotlightKey. More... | |
void | Show (out HPS.SpotlightKit out_kit) |
Copy the contents of this SpotlightKey into the specified kit. More... | |
bool | ShowCameraRelative (out bool out_state) |
Shows whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space. More... | |
bool | ShowColor (out HPS.Material.Type out_type, out HPS.RGBAColor out_rgba_color, out float out_index) |
Shows the color for this SpotlightKey. More... | |
bool | ShowConcentration (out float out_concentration) |
Shows the concentration for this SpotlightKey. More... | |
bool | ShowInnerCone (out float out_size, out HPS.Spotlight.InnerConeUnits out_units) |
Shows the inner cone for this SpotlightKey. More... | |
bool | ShowOuterCone (out float out_size, out HPS.Spotlight.OuterConeUnits out_units) |
Shows the outer cone for this SpotlightKey. More... | |
bool | ShowPosition (out HPS.Point out_position) |
Shows the position of the light source for this SpotlightKey. More... | |
bool | ShowTarget (out HPS.Point out_target) |
Shows the target coordinate towards which the light source points for this SpotlightKey. More... | |
SpotlightKey () | |
The default constructor creates an uninitialized SpotlightKey object. More... | |
SpotlightKey (HPS.Key in_that) | |
This constructor creates a SpotlightKey object that shares the underlying smart-pointer of the source Key. More... | |
SpotlightKey (HPS.SpotlightKey in_that) | |
This constructor creates a SpotlightKey object that shares the underlying smart-pointer of the source Key. More... | |
HPS.SpotlightKey | UnsetColor () |
Removes the color (RGBA or material index) set on this SpotlightKey. More... | |
![]() | |
GeometryKey () | |
The default constructor creates an uninitialized GeometryKey object. More... | |
GeometryKey (HPS.Key in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
GeometryKey (HPS.GeometryKey in_that) | |
This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More... | |
HPS.GeometryKey | SetPriority (int in_priority) |
Assigns a drawing priority value to the geometry. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr in_index, byte[] in_data) |
Sets user data on this key. More... | |
HPS.GeometryKey | SetUserData (IntPtr[] in_indices, byte[][] in_data) |
Sets user data on this key. More... | |
bool | ShowBoundings (out HPS.BoundingKit out_kit) |
Shows the bounding of this geometry. More... | |
bool | ShowPriority (out int out_priority) |
Shows the drawing priority. More... | |
ulong | ShowReferrers (out HPS.SegmentKey[] out_segments) |
Shows the all the segments which contain references to this key. More... | |
ulong | ShowReferrers (out HPS.ReferenceKey[] out_references) |
Shows the all the references to this key. More... | |
bool | ShowUserData (IntPtr in_index, out byte[] out_data) |
Shows the user data at a given index for this key. More... | |
bool | ShowUserData (out IntPtr[] out_indices, out byte[][] out_data) |
Shows all user data for this key. More... | |
ulong | ShowUserDataCount () |
Get the number of user data indices set on this key. More... | |
bool | ShowUserDataIndices (out IntPtr[] out_indices) |
Shows the indices of all user data set on this key. More... | |
HPS.GeometryKey | UnsetAllUserData () |
Removes all user data from this key. More... | |
HPS.GeometryKey | UnsetPriority () |
Removes the drawing priority setting. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr in_index) |
Removes the user data at the given index from this key. More... | |
HPS.GeometryKey | UnsetUserData (IntPtr[] in_indices) |
Removes the user data at the given indices from this key. More... | |
![]() | |
virtual void | Assign (HPS.Key in_that) |
Share the smart-pointer. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. More... | |
void | Delete () |
Removes the database object referred to by this key. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Key in_that) |
Determines whether the database objects pointed to by this key and in_that are the same. More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
Key () | |
An uninitialized key refers to no database object and Type() will return Type::None. More... | |
Key (HPS.Key in_that) | |
Shares a reference to a database object referred to by in_that. More... | |
Key (HPS.Control in_control) | |
Initializes a key tied to the Control in_control. More... | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. 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... | |
Protected Member Functions | |
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 |
HandleRef | scptr |
The SpotlightKey class is a smart pointer to a database object.
It is a handle to a spotlight inserted via SegmentKey::InsertSpotlight.
HPS.SpotlightKey.SpotlightKey | ( | ) |
The default constructor creates an uninitialized SpotlightKey object.
The Type() function will return Type::None.
HPS.SpotlightKey.SpotlightKey | ( | HPS.Key | in_that | ) |
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.
HPS.SpotlightKey.SpotlightKey | ( | HPS.SpotlightKey | in_that | ) |
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.
void HPS.SpotlightKey.Consume | ( | HPS.SpotlightKit | in_kit | ) |
Completely replaces all settings on this SpotlightKey with those set on the specified kit and resets the kit.InfiniteLineKey
in_kit | The kit from which to get the settings to replace on this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
|
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.GeometryKey.
void HPS.SpotlightKey.Set | ( | HPS.SpotlightKit | in_kit | ) |
Replace those settings on this SpotlightKey with those set on the specified kit.
in_kit | The kit from which to get the settings to replace on this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
HPS.SpotlightKey HPS.SpotlightKey.SetCameraRelative | ( | bool | in_state | ) |
Sets whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space.
in_state | Whether the coordinates of the position and target for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref> are treated as being in object space or camera-relative space. |
SetPosition
SetTarget
HPS.SpotlightKey HPS.SpotlightKey.SetColor | ( | HPS.RGBAColor | in_rgba_color | ) |
Sets the RGBA color to use for this SpotlightKey.
in_rgba_color | The RGBA color to use for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
HPS.SpotlightKey HPS.SpotlightKey.SetColorByIndex | ( | float | in_index | ) |
Sets the color index to use for this SpotlightKey.
in_index | The color index to use for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
HPS.SpotlightKey HPS.SpotlightKey.SetConcentration | ( | float | in_concentration | ) |
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.
in_concentration | The concentration for the <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</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.SpotlightKey HPS.SpotlightKey.SetInnerCone | ( | float | in_size, |
HPS.Spotlight.InnerConeUnits | in_units | ||
) |
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.
in_size | The size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</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_key" kindref="compound">SpotlightKey</ref>. Defaults to <ref refid="class_h_p_s_1_1_spotlight_1ab5c133cf880f3bc99af7a656bee6c17da9ef125630442bb42e2e367e0cf70d892" kindref="member">Spotlight::InnerConeUnits::Degrees</ref>. |
HPS.SpotlightKey HPS.SpotlightKey.SetInnerCone | ( | float | in_size | ) |
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.
in_size | The size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. The interpretation of the value and its valid range depends on the units argument. |
HPS.SpotlightKey HPS.SpotlightKey.SetOuterCone | ( | float | in_size, |
HPS.Spotlight.OuterConeUnits | in_units | ||
) |
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.
in_size | The size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</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_key" kindref="compound">SpotlightKey</ref>. Defaults to <ref refid="class_h_p_s_1_1_spotlight_1a6caa7c688111e49f76955e28e4797fd5a9ef125630442bb42e2e367e0cf70d892" kindref="member">Spotlight::OuterConeUnits::Degrees</ref>. |
HPS.SpotlightKey HPS.SpotlightKey.SetOuterCone | ( | float | in_size | ) |
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.
in_size | The size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. The interpretation of the value and its valid range depends on the units argument. |
HPS.SpotlightKey HPS.SpotlightKey.SetPosition | ( | HPS.Point | in_position | ) |
Sets the position of the light source for this SpotlightKey.
in_position | The position of the light source for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</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.SpotlightKey HPS.SpotlightKey.SetTarget | ( | HPS.Point | in_target | ) |
Sets the target coordinate towards which the light source points for this SpotlightKey.
in_target | The target coordinate towards which the light source points for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</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
void HPS.SpotlightKey.Show | ( | out HPS.SpotlightKit | out_kit | ) |
Copy the contents of this SpotlightKey into the specified kit.
out_kit | The kit to populate with the contents of this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
bool HPS.SpotlightKey.ShowCameraRelative | ( | out bool | out_state | ) |
Shows whether the coordinates of the position and target for this SpotlightKey are treated as being in object space or camera-relative space.
out_state | Whether the coordinates of the position and target for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref> are treated as being in object space or camera-relative space. |
bool HPS.SpotlightKey.ShowColor | ( | out HPS.Material.Type | out_type, |
out HPS.RGBAColor | out_rgba_color, | ||
out float | out_index | ||
) |
Shows the color for this SpotlightKey.
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.SpotlightKey.ShowConcentration | ( | out float | out_concentration | ) |
Shows the concentration for this SpotlightKey.
out_concentration | The concentration for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
bool HPS.SpotlightKey.ShowInnerCone | ( | out float | out_size, |
out HPS.Spotlight.InnerConeUnits | out_units | ||
) |
Shows the inner cone for this SpotlightKey.
out_size | The size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
out_units | The units for the size of the inner cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
bool HPS.SpotlightKey.ShowOuterCone | ( | out float | out_size, |
out HPS.Spotlight.OuterConeUnits | out_units | ||
) |
Shows the outer cone for this SpotlightKey.
out_size | The size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
out_units | The units for the size of the outer cone for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
bool HPS.SpotlightKey.ShowPosition | ( | out HPS.Point | out_position | ) |
Shows the position of the light source for this SpotlightKey.
out_position | The position of the light source for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
bool HPS.SpotlightKey.ShowTarget | ( | out HPS.Point | out_target | ) |
Shows the target coordinate towards which the light source points for this SpotlightKey.
out_target | The target coordinate towards which the light source points for this <ref refid="class_h_p_s_1_1_spotlight_key" kindref="compound">SpotlightKey</ref>. |
HPS.SpotlightKey HPS.SpotlightKey.UnsetColor | ( | ) |
Removes the color (RGBA or material index) set on this SpotlightKey.