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. More...

Inheritance diagram for HPS.SpotlightKit:
HPS.Object

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. This does not necessarily give the true type of the underlying object. 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. This defines what the implied units of the target and position will be. 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. 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. 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. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority. 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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Static Public Member Functions

static HPS.SpotlightKit 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. More...
 
static bool operator!= (HPS.SpotlightKit a, HPS.SpotlightKit b)
 
static bool operator== (HPS.SpotlightKit a, HPS.SpotlightKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

HPS.SpotlightKit.SpotlightKit ( )
inline

The default constructor creates an empty SpotlightKit object.

HPS.SpotlightKit.SpotlightKit ( HPS.SpotlightKit  in_kit)
inline

The copy constructor creates a new SpotlightKit object that contains the same settings as the source SpotlightKit.

Parameters
in_kitThe source SpotlightKit to copy.

Member Function Documentation

void HPS.SpotlightKit.Consume ( HPS.SpotlightKit  in_kit)
inline

Copies the source SpotlightKit into this SpotlightKit and resets the source kit.

Parameters
in_kitThe source SpotlightKit to consume.
override bool HPS.SpotlightKit.Empty ( )
inlinevirtual

Indicates whether this SpotlightKit has any values set on it.

Returns
true if no values are set on this SpotlightKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.SpotlightKit.Equals ( HPS.SpotlightKit  in_kit)
inline

Check if the source SpotlightKit is equivalent to this SpotlightKit.

Parameters
in_kitThe source SpotlightKit to compare to this SpotlightKit.
Returns
true if the objects are equivalent, false otherwise.
static HPS.SpotlightKit HPS.SpotlightKit.GetDefault ( )
inlinestatic

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.
override HPS.Type HPS.SpotlightKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.SpotlightKit.Set ( HPS.SpotlightKit  in_kit)
inline

Copies the source SpotlightKit into this SpotlightKit.

Parameters
in_kitThe source SpotlightKit to copy.
HPS.SpotlightKit HPS.SpotlightKit.SetCameraRelative ( bool  in_state)
inline

Sets the camera-relative setting for this SpotlightKit. This defines what the implied units of the target and position will be.

Parameters
in_stateWhether 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.

SetPosition

SetTarget

HPS.SpotlightKit HPS.SpotlightKit.SetColor ( HPS.RGBAColor  in_rgba_color)
inline

Sets the RGBA color to use for this SpotlightKit.

Parameters
in_rgba_colorThe RGBA color to use for this SpotlightKit.
Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.SetColorByIndex ( float  in_index)
inline

Sets the color index to use for this SpotlightKit.

Parameters
in_indexThe color index to use for this SpotlightKit.
Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.SetConcentration ( float  in_concentration)
inline

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_concentrationThe 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.
HPS.SpotlightKit HPS.SpotlightKit.SetInnerCone ( float  in_size,
HPS.Spotlight.InnerConeUnits  in_units 
)
inline

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_sizeThe size of the inner cone for this SpotlightKit. The interpretation of the value and its valid range depends on the units argument.
in_unitsThe units for the size of the inner cone for this SpotlightKit. Defaults to Spotlight.InnerConeUnits.Percent.
Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.SetInnerCone ( float  in_size)
inline

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_sizeThe 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.
HPS.SpotlightKit HPS.SpotlightKit.SetOuterCone ( float  in_size,
HPS.Spotlight.OuterConeUnits  in_units 
)
inline

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_sizeThe size of the outer cone for this SpotlightKit. The interpretation of the value and its valid range depends on the units argument.
in_unitsThe units for the size of the outer cone for this SpotlightKit. Defaults to Spotlight.OuterConeUnits.Degrees.
Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.SetOuterCone ( float  in_size)
inline

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_sizeThe 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.
HPS.SpotlightKit HPS.SpotlightKit.SetPosition ( HPS.Point  in_position)
inline

Sets the position of the light source for this SpotlightKit.

Parameters
in_positionThe 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.

SetCameraRelative

HPS.SpotlightKit HPS.SpotlightKit.SetPriority ( int  in_priority)
inline

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_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.

SubwindowKit.SetPriority()

SubwindowKit.SetRenderingAlgorithm()

HPS.SpotlightKit HPS.SpotlightKit.SetTarget ( HPS.Point  in_target)
inline

Sets the target coordinate towards which the light source points for this SpotlightKit.

Parameters
in_targetThe 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.

SetCameraRelative

HPS.SpotlightKit HPS.SpotlightKit.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte[]  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.SpotlightKit HPS.SpotlightKit.SetUserData ( IntPtr  in_index,
byte[]  in_data 
)
inline

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.
HPS.SpotlightKit HPS.SpotlightKit.SetUserData ( IntPtr[]  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.
void HPS.SpotlightKit.Show ( out HPS.SpotlightKit  out_kit)
inline

Copies this SpotlightKit into the given SpotlightKit.

Parameters
out_kitThe SpotlightKit to populate with the contents of this SpotlightKit.
bool HPS.SpotlightKit.ShowCameraRelative ( out bool  out_state)
inline

Shows the camera-relative setting for this SpotlightKit.

Parameters
out_stateWhether 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.
bool HPS.SpotlightKit.ShowColor ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_rgba_color,
out float  out_index 
)
inline

Shows the color for this SpotlightKit.

Parameters
out_typeThe type of color for the spotlight.
out_rgba_colorThe RGBA color for the spotlight. This is only valid if out_type is Material.Type.RGBAColor.
out_indexThe 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.
bool HPS.SpotlightKit.ShowConcentration ( out float  out_concentration)
inline

Shows the concentration for this SpotlightKit.

Parameters
out_concentrationThe concentration for this SpotlightKit.
Returns
true if a concentration was set, false otherwise.
bool HPS.SpotlightKit.ShowInnerCone ( out float  out_size,
out HPS.Spotlight.InnerConeUnits  out_units 
)
inline

Shows the inner cone for this SpotlightKit.

Parameters
out_sizeThe size of the inner cone for this SpotlightKit.
out_unitsThe units for the size of the inner cone for this SpotlightKit.
Returns
true if an inner cone was set, false otherwise.
bool HPS.SpotlightKit.ShowOuterCone ( out float  out_size,
out HPS.Spotlight.OuterConeUnits  out_units 
)
inline

Shows the outer cone for this SpotlightKit.

Parameters
out_sizeThe size of the outer cone for this SpotlightKit.
out_unitsThe units for the size of the outer cone for this SpotlightKit.
Returns
true if an outer cone was set, false otherwise.
bool HPS.SpotlightKit.ShowPosition ( out HPS.Point  out_position)
inline

Shows the position of the light source for this SpotlightKit.

Parameters
out_positionThe position of the light source for this SpotlightKit.
Returns
true if a light source position was set, false otherwise.
bool HPS.SpotlightKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if a drawing priority was specified, false otherwise.
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_targetThe target coordinate towards which the light source points for this SpotlightKit.
Returns
true if a target was set, false otherwise.
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_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.
bool HPS.SpotlightKit.ShowUserData ( out IntPtr[]  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.
ulong HPS.SpotlightKit.ShowUserDataCount ( )
inline

Get the number of user data indices set on this kit.

bool HPS.SpotlightKit.ShowUserDataIndices ( out IntPtr[]  out_indices)
inline

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetCameraRelative ( )
inline

Removes the camera-relative setting for this SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetColor ( )
inline

Removes the color (RGBA or material index) for this SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetConcentration ( )
inline

Removes the concentration for this SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetEverything ( )
inline

Removes all settings from the SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetInnerCone ( )
inline

Removes the inner-cone size specification for this SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetOuterCone ( )
inline

Removes the outer-cone size specification for this SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetPosition ( )
inline

Removes the light source position for this SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetPriority ( )
inline

Removes the drawing priority setting.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetTarget ( )
inline

Removes the target coordinate towards which the light source points for this SpotlightKit.

Returns
A reference to this SpotlightKit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.
HPS.SpotlightKit HPS.SpotlightKit.UnsetUserData ( IntPtr[]  in_indices)
inline

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe 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