Public Member Functions | Protected Member Functions | List of all members
HPS.InfiniteLineKey Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 InfiniteLineKey ()
 The default constructor creates an uninitialized InfiniteLineKey object. The Type() function will return Type::None. More...
 
 InfiniteLineKey (HPS.Key in_that)
 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. More...
 
 InfiniteLineKey (HPS.InfiniteLineKey in_that)
 The copy constructor creates an InfiniteLineKey object that shares the underlying smart-pointer of the source InfiniteLineKey. More...
 
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 Consume (HPS.InfiniteLineKit in_kit)
 Completely replaces all settings on this InfiniteLineKey with those set on the specified kit and resets the kit. More...
 
void Set (HPS.InfiniteLineKit in_kit)
 Replace those settings on this InfiniteLineKey with those set on the specified kit. More...
 
void Show (out HPS.InfiniteLineKit out_kit)
 Copy the contents of this InfiniteLineKey into the specified kit. More...
 
HPS.InfiniteLineKey SetFirst (HPS.Point in_first)
 Sets the first point for this InfiniteLineKey. More...
 
HPS.InfiniteLineKey SetSecond (HPS.Point in_second)
 Sets the second point for this InfiniteLineKey. More...
 
HPS.InfiniteLineKey SetType (HPS.InfiniteLine.Type in_type)
 Sets the type of this InfiniteLineKey. More...
 
bool ShowFirst (out HPS.Point out_first)
 Shows the first point for this InfiniteLineKey. More...
 
bool ShowSecond (out HPS.Point out_second)
 Shows the second point for this InfiniteLineKey. More...
 
bool ShowType (out HPS.InfiniteLine.Type out_type)
 Shows the type of this InfiniteLineKey. 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...
 
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...
 
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 UnsetPriority ()
 Removes the drawing priority setting. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. 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...
 
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...
 
HPS.GeometryKey UnsetAllUserData ()
 Removes all user data from 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...
 
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...
 
bool ShowBoundings (out HPS.BoundingKit out_kit)
 Shows the bounding of this geometry. More...
 
- Public Member Functions inherited from HPS.Key
override void Dispose ()
 
 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...
 
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...
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

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

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

 
void Delete ()
 Removes the database object referred to by this key. 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.Key CopyTo (HPS.SegmentKey in_destination)
 Copies the database object referred to by this key into a segment pointed to by in_destination. More...
 
virtual void Assign (HPS.Key in_that)
 Share the underlying smart-pointer of the Key source. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

HPS.InfiniteLineKey.InfiniteLineKey ( )
inline

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

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

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