The SpotlightKey class is a smart pointer to a database object. It is a handle to a spotlight inserted via SegmentKey.InsertSpotlight. More...

Inheritance diagram for HPS.SpotlightKey:
HPS.GeometryKey HPS.Key HPS.Object

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. This does not necessarily give the true type of the underlying object. 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. 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.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. More...
 
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. More...
 
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. More...
 
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. 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. The Type() function will return Type.None. More...
 
 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. More...
 
 SpotlightKey (HPS.SpotlightKey in_that)
 The copy constructor creates a SpotlightKey object that shares the underlying smart-pointer of the source SpotlightKey. More...
 
HPS.SpotlightKey UnsetColor ()
 Removes the color (RGBA or material index) set on this SpotlightKey. More...
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None. More...
 
 GeometryKey (HPS.Key in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More...
 
HPS.GeometryKey SetPriority (int in_priority)
 Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. 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 ShowBounding (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. Note that while a segment may only appear once in the returned array, that segment could have multiple 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...
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 Share the underlying smart-pointer of the Key source. 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. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
 
ulong GetHash ()
 Returns a hash code for the key. More...
 
override int GetHashCode ()
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
 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 ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
- Public Member Functions inherited from HPS.Object
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. 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...
 
virtual 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...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The SpotlightKey class is a smart pointer to a database object. It is a handle to a spotlight inserted via SegmentKey.InsertSpotlight.

Constructor & Destructor Documentation

HPS.SpotlightKey.SpotlightKey ( )
inline

The default constructor creates an uninitialized SpotlightKey object. The Type() function will return Type.None.

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.

HPS.SpotlightKey.SpotlightKey ( HPS.SpotlightKey  in_that)
inline

The copy constructor creates a SpotlightKey object that shares the underlying smart-pointer of the source SpotlightKey.

Parameters
in_thatThe source SpotlightKey to copy.

Member Function Documentation

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

Completely replaces all settings on this SpotlightKey with those set on the specified kit and resets the kit.InfiniteLineKey

Parameters
in_kitThe kit from which to get the settings to replace on this SpotlightKey.
override HPS.Type HPS.SpotlightKey.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.GeometryKey.

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

Replace those settings on this SpotlightKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this SpotlightKey.
HPS.SpotlightKey HPS.SpotlightKey.SetCameraRelative ( bool  in_state)
inline

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

SetPosition

SetTarget

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

Sets the RGBA color to use for this SpotlightKey.

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

Sets the color index to use for this SpotlightKey.

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

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

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_sizeThe size of the inner cone for this SpotlightKey. 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 SpotlightKey. Defaults to Spotlight.InnerConeUnits.Degrees.
Returns
A reference to this SpotlightKey.
HPS.SpotlightKey HPS.SpotlightKey.SetInnerCone ( float  in_size)
inline

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

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_sizeThe size of the outer cone for this SpotlightKey. 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 SpotlightKey. Defaults to Spotlight.OuterConeUnits.Degrees.
Returns
A reference to this SpotlightKey.
HPS.SpotlightKey HPS.SpotlightKey.SetOuterCone ( float  in_size)
inline

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

Sets the position of the light source for this SpotlightKey.

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

SetCameraRelative

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

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

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

SetCameraRelative

void HPS.SpotlightKey.Show ( out HPS.SpotlightKit  out_kit)
inline

Copy the contents of this SpotlightKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this SpotlightKey.
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_stateWhether 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.
bool HPS.SpotlightKey.ShowColor ( out HPS.Material.Type  out_type,
out HPS.RGBAColor  out_rgba_color,
out float  out_index 
)
inline

Shows the color for this SpotlightKey.

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.SpotlightKey.ShowConcentration ( out float  out_concentration)
inline

Shows the concentration for this SpotlightKey.

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

Shows the inner cone for this SpotlightKey.

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

Shows the outer cone for this SpotlightKey.

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

Shows the position of the light source for this SpotlightKey.

Parameters
out_positionThe position of the light source for this SpotlightKey.
Returns
true if a light source position was set, false otherwise.
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_targetThe target coordinate towards which the light source points for this SpotlightKey.
Returns
true if a target was set, false otherwise.
HPS.SpotlightKey HPS.SpotlightKey.UnsetColor ( )
inline

Removes the color (RGBA or material index) set on this SpotlightKey.

Returns
A reference to this SpotlightKey.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.SpotlightKey.cs