< Home

< Table of Contents

REFERENCE MANUAL

HPS.LineKey Class Reference

The LineKey class is a smart pointer to a database object. More...

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

Public Member Functions

void Consume (HPS.LineKit in_kit)
 Completely replaces all settings on this LineKey with those set on the specified kit and resets the kit. More...
 
override void Dispose ()
 
HPS.LineKey EditPointsByDeletion (ulong in_offset, ulong in_count)
 Removes points from the point list for this LineKey. More...
 
HPS.LineKey EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 Adds points to the point list for this LineKey. More...
 
HPS.LineKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 Replaces points in the point list for this LineKey. More...
 
ulong GetPointCount ()
 Retrieves the number of points in this line. More...
 
 LineKey ()
 The default constructor creates an uninitialized LineKey object. More...
 
 LineKey (HPS.Key in_that)
 This constructor creates a LineKey object that shares the underlying smart-pointer of the source Key. More...
 
 LineKey (HPS.LineKey in_that)
 This constructor creates a LineKey object that shares the underlying smart-pointer of the source Key. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.LineKit in_kit)
 Copies the source LineKit into this LineKit. More...
 
HPS.LineKey SetPoints (HPS.Point[] in_points)
 Sets the points for this LineKey. More...
 
void Show (out HPS.LineKit out_kit)
 Copies this LineKit into the given LineKit. More...
 
bool ShowPoints (out HPS.Point[] out_points)
 Shows the points for this LineKey. More...
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. More...
 
 GeometryKey (HPS.Key in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More...
 
HPS.GeometryKey SetPriority (int in_priority)
 Assigns a drawing priority value to the geometry. 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 ShowBoundings (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. 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 smart-pointer. 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. 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. 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
 
HandleRef scptr
 

Detailed Description

The LineKey class is a smart pointer to a database object.

It is a handle to a line inserted via SegmentKey::InsertLine.

Constructor & Destructor Documentation

HPS.LineKey.LineKey ( )

The default constructor creates an uninitialized LineKey object.

The Type() function will return Type::None.

HPS.LineKey.LineKey ( HPS.Key  in_that)

This constructor creates a LineKey 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 Line key. Otherwise the copy will fail and the resulting LineKey will be invalid.

HPS.LineKey.LineKey ( HPS.LineKey  in_that)

This constructor creates a LineKey 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 Line key. Otherwise the copy will fail and the resulting LineKey will be invalid.

Member Function Documentation

void HPS.LineKey.Consume ( HPS.LineKit  in_kit)

Completely replaces all settings on this LineKey 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 <ref refid="class_h_p_s_1_1_line_key" kindref="compound">LineKey</ref>.
HPS.LineKey HPS.LineKey.EditPointsByDeletion ( ulong  in_offset,
ulong  in_count 
)

Removes points from the point list for this LineKey.

Parameters
in_offsetThe offset into the point list for the line at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed.
in_countThe number of points to delete from the point list for the line. This value must be such that in_offset+in_count<=point_count for the deletion to succeed.
Returns
A reference to this LineKey.
HPS.LineKey HPS.LineKey.EditPointsByInsertion ( ulong  in_offset,
HPS.Point[]  in_points 
)

Adds points to the point list for this LineKey.

Parameters
in_offsetThe offset into the point list for the line at which to insert points. This value must be such that in_offset<point_count for insertion to succeed.
in_countSize of the following array.
in_pointsThe points to insert into the point list at the specified offset.
Returns
A reference to this LineKey.
HPS.LineKey HPS.LineKey.EditPointsByReplacement ( ulong  in_offset,
HPS.Point[]  in_points 
)

Replaces points in the point list for this LineKey.

Parameters
in_offsetThe offset into the point list for the line at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed.
in_countSize of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed.
in_pointsThe points to use to replace those in the point list at the specified offset.
Returns
A reference to this LineKey.
ulong HPS.LineKey.GetPointCount ( )

Retrieves the number of points in this line.

Returns
The number of points in this line.
override HPS.Type HPS.LineKey.ObjectType ( )
virtual

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.LineKey.Set ( HPS.LineKit  in_kit)

Copies the source LineKit into this LineKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to copy.
HPS.LineKey HPS.LineKey.SetPoints ( HPS.Point[]  in_points)

Sets the points for this LineKey.

Parameters
in_countSize of the following array.
in_pointsThe points for this <ref refid="class_h_p_s_1_1_line_key" kindref="compound">LineKey</ref>.
Returns
A reference to this LineKey.
void HPS.LineKey.Show ( out HPS.LineKit  out_kit)

Copies this LineKit into the given LineKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_line_kit" kindref="compound">LineKit</ref>.
bool HPS.LineKey.ShowPoints ( out HPS.Point[]  out_points)

Shows the points for this LineKey.

Returns
true if points were set, false otherwise.

The documentation for this class was generated from the following file: