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

Public Member Functions

void Consume (HPS.InfiniteLineKit in_kit)
 
override void Dispose ()
 
 InfiniteLineKey ()
 
 InfiniteLineKey (HPS.Key in_that)
 
 InfiniteLineKey (HPS.InfiniteLineKey in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.InfiniteLineKit in_kit)
 
HPS.InfiniteLineKey SetFirst (HPS.Point in_first)
 
HPS.InfiniteLineKey SetSecond (HPS.Point in_second)
 
HPS.InfiniteLineKey SetType (HPS.InfiniteLine.Type in_type)
 
void Show (out HPS.InfiniteLineKit out_kit)
 
bool ShowFirst (out HPS.Point out_first)
 
bool ShowSecond (out HPS.Point out_second)
 
bool ShowType (out HPS.InfiniteLine.Type out_type)
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
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.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
override HPS.Type ObjectType ()
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Key
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 InfiniteLineKey class is a smart pointer to a database object. It is a handle to an infinite line or ray inserted via SegmentKey.InsertInfiniteLine.

Constructor & Destructor Documentation

◆ InfiniteLineKey() [1/3]

HPS.InfiniteLineKey.InfiniteLineKey ( )
inline

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

◆ InfiniteLineKey() [2/3]

HPS.InfiniteLineKey.InfiniteLineKey ( HPS.Key  in_that)
inline

This constructor creates an InfiniteLineKey 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 an InfiniteLine key. Otherwise the copy will fail and the resulting InfiniteLineKey will be invalid.

Parameters
in_thatThe source Key to copy.

◆ InfiniteLineKey() [3/3]

HPS.InfiniteLineKey.InfiniteLineKey ( HPS.InfiniteLineKey  in_that)
inline

The copy constructor creates an InfiniteLineKey object that shares the underlying smart-pointer of the source InfiniteLineKey.

Parameters
in_thatThe source InfiniteLineKey to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe kit from which to get the settings to replace on this InfiniteLineKey.

◆ ObjectType()

override HPS.Type HPS.InfiniteLineKey.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.GeometryKey.

◆ Set()

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

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

Parameters
in_kitThe kit from which to get the settings to replace on this InfiniteLineKey.

◆ SetFirst()

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

Sets the first point for this InfiniteLineKey.

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

◆ SetSecond()

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

Sets the second point for this InfiniteLineKey.

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

◆ SetType()

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

Sets the type of this InfiniteLineKey.

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

◆ Show()

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

Copy the contents of this InfiniteLineKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this InfiniteLineKey.

◆ ShowFirst()

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

Shows the first point for this InfiniteLineKey.

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

◆ ShowSecond()

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

Shows the second point for this InfiniteLineKey.

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

◆ ShowType()

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

Shows the type of this InfiniteLineKey.

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

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