Inheritance diagram for HPS.InfiniteLineKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.InfiniteLineKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.InfiniteLineKit in_kit)
 
override int GetHashCode ()
 
 InfiniteLineKit ()
 
 InfiniteLineKit (HPS.InfiniteLineKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.InfiniteLineKit in_kit)
 
HPS.InfiniteLineKit SetFirst (HPS.Point in_first)
 
HPS.InfiniteLineKit SetPriority (int in_priority)
 
HPS.InfiniteLineKit SetSecond (HPS.Point in_second)
 
HPS.InfiniteLineKit SetType (HPS.InfiniteLine.Type in_type)
 
HPS.InfiniteLineKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.InfiniteLineKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.InfiniteLineKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
void Show (out HPS.InfiniteLineKit out_kit)
 
bool ShowFirst (out HPS.Point out_first)
 
bool ShowPriority (out int out_priority)
 
bool ShowSecond (out HPS.Point out_second)
 
bool ShowType (out HPS.InfiniteLine.Type out_type)
 
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)
 
HPS.InfiniteLineKit UnsetAllUserData ()
 
HPS.InfiniteLineKit UnsetEverything ()
 
HPS.InfiniteLineKit UnsetFirst ()
 
HPS.InfiniteLineKit UnsetPriority ()
 
HPS.InfiniteLineKit UnsetSecond ()
 
HPS.InfiniteLineKit UnsetType ()
 
HPS.InfiniteLineKit UnsetUserData (IntPtr in_index)
 
HPS.InfiniteLineKit UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.InfiniteLineKit a, HPS.InfiniteLineKit b)
 
static bool operator== (HPS.InfiniteLineKit a, HPS.InfiniteLineKit 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.Kit
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 InfiniteLineKit class is a user space object. It is a kit analog to an InfiniteLineKey.

Constructor & Destructor Documentation

◆ InfiniteLineKit() [1/2]

HPS.InfiniteLineKit.InfiniteLineKit ( )
inline

The default constructor creates an empty InfiniteLineKit object.

◆ InfiniteLineKit() [2/2]

HPS.InfiniteLineKit.InfiniteLineKit ( HPS.InfiniteLineKit  in_kit)
inline

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

Parameters
in_kitThe source InfiniteLineKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source InfiniteLineKit to consume.

◆ Empty()

override bool HPS.InfiniteLineKit.Empty ( )
inlinevirtual

Indicates whether this InfiniteLineKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit.

Parameters
in_kitThe source InfiniteLineKit to compare to this InfiniteLineKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.InfiniteLineKit.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.Object.

◆ Set()

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

Copies the source InfiniteLineKit into this InfiniteLineKit.

Parameters
in_kitThe source InfiniteLineKit to copy.

◆ SetFirst()

HPS.InfiniteLineKit HPS.InfiniteLineKit.SetFirst ( HPS.Point  in_first)
inline

Sets the first point for this InfiniteLineKit.

Parameters
in_firstThe first point for this InfiniteLineKit. If the type is InfiniteLine.Type.Ray, this will be the point at which the ray starts.
Returns
A reference to this InfiniteLineKit.

◆ SetPriority()

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

Assigns a specific drawing priority value to the InfiniteLineKit. 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.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetSecond()

HPS.InfiniteLineKit HPS.InfiniteLineKit.SetSecond ( HPS.Point  in_second)
inline

Sets the second point for this InfiniteLineKit.

Parameters
in_secondThe second point for this InfiniteLineKit. If the type is InfiniteLine.Type.Ray, this will be the point through which the ray passes.
Returns
A reference to this InfiniteLineKit.

◆ SetType()

HPS.InfiniteLineKit HPS.InfiniteLineKit.SetType ( HPS.InfiniteLine.Type  in_type)
inline

Sets the type of this InfiniteLineKit.

Parameters
in_typeThe type of this InfiniteLineKit.
Returns
A reference to this InfiniteLineKit.

◆ SetUserData() [1/3]

HPS.InfiniteLineKit HPS.InfiniteLineKit.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.

◆ SetUserData() [2/3]

HPS.InfiniteLineKit HPS.InfiniteLineKit.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.

◆ SetUserData() [3/3]

HPS.InfiniteLineKit HPS.InfiniteLineKit.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.

◆ Show()

void HPS.InfiniteLineKit.Show ( out HPS.InfiniteLineKit  out_kit)
inline

Copies this InfiniteLineKit into the given InfiniteLineKit.

Parameters
out_kitThe InfiniteLineKit to populate with the contents of this InfiniteLineKit.

◆ ShowFirst()

bool HPS.InfiniteLineKit.ShowFirst ( out HPS.Point  out_first)
inline

Shows the first point for this InfiniteLineKit.

Parameters
out_firstThe first point for this InfiniteLineKit.
Returns
true if a first point was set, false otherwise.

◆ ShowPriority()

bool HPS.InfiniteLineKit.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 the setting is valid, false otherwise.

◆ ShowSecond()

bool HPS.InfiniteLineKit.ShowSecond ( out HPS.Point  out_second)
inline

Shows the second point for this InfiniteLineKit.

Parameters
out_secondThe second point for this InfiniteLineKit.
Returns
true if a second point was set, false otherwise.

◆ ShowType()

bool HPS.InfiniteLineKit.ShowType ( out HPS.InfiniteLine.Type  out_type)
inline

Shows the type of this InfiniteLineKit.

Parameters
out_typeThe type of this InfiniteLineKit.
Returns
true if a type was set, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.InfiniteLineKit.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.

◆ ShowUserData() [2/2]

bool HPS.InfiniteLineKit.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.

◆ ShowUserDataCount()

ulong HPS.InfiniteLineKit.ShowUserDataCount ( )
inline

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

◆ ShowUserDataIndices()

bool HPS.InfiniteLineKit.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.

◆ UnsetAllUserData()

HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetEverything ( )
inline

Removes all settings from the InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetFirst()

HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetFirst ( )
inline

Removes the first point for this InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetPriority()

HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetSecond()

HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetSecond ( )
inline

Removes the second point for this InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetType()

HPS.InfiniteLineKit HPS.InfiniteLineKit.UnsetType ( )
inline

Removes the type of this InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetUserData() [1/2]

HPS.InfiniteLineKit HPS.InfiniteLineKit.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.

◆ UnsetUserData() [2/2]

HPS.InfiniteLineKit HPS.InfiniteLineKit.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.InfiniteLineKit.cs