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. The Type() function will return Type.None. More...
 
 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. More...
 
 LineKey (HPS.LineKey in_that)
 The copy constructor creates a LineKey object that shares the underlying smart-pointer of the source LineKey. More...
 
override HPS.Type ObjectType ()
 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). More...
 
void Set (HPS.LineKit in_kit)
 Copies the source LineKit into this LineKit. More...
 
HPS.LineKey SetPointCoordinateSpace (ulong[] in_indices, HPS.Line.CoordinateSpace[] in_spaces)
 Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object. More...
 
HPS.LineKey SetPointCoordinateSpace (HPS.Line.CoordinateSpace[] in_spaces)
 Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object. More...
 
HPS.LineKey SetPoints (HPS.Point[] in_points)
 Sets the points for this LineKey. More...
 
HPS.LineKey SetPoints (HPS.Point[] in_points, HPS.Line.CoordinateSpace[] in_spaces)
 Sets the points for this LineKey. More...
 
void Show (out HPS.LineKit out_kit)
 Copies this LineKit into the given LineKit. More...
 
bool ShowPointCoordinateSpace (ulong[] in_indices, out HPS.Line.CoordinateSpace[] out_spaces)
 Shows the coordinate space that is being used for the points at the specified indices. More...
 
bool ShowPointCoordinateSpace (out HPS.Line.CoordinateSpace[] out_spaces)
 Shows the coordinate space that is being used for the points at the specified indices. More...
 
bool ShowPoints (out HPS.Point[] out_points)
 Shows the points for this LineKey. More...
 
bool ShowPoints (out HPS.Point[] out_points, out HPS.Line.CoordinateSpace[] out_coordinate_spaces)
 Shows the points for this LineKey. More...
 
bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)
 Show a subset of the points for this LineKey by list. More...
 
bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)
 Show a subset of the points for this LineKey by range. More...
 
HPS.LineKey UnsetPointCoordinateSpace (ulong[] in_indices)
 Unsets the coordinate space for specified points on this line back to Coordinate.Space.Object. More...
 
HPS.LineKey UnsetPointCoordinateSpace ()
 Unsets the coordinate space for all points on this line back to Coordinate.Space.Object. 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 rendered when the rendering algorithm is set to Priority. All geometry has a default drawing priority assigned based on the order of insertion into the segment. 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)
 Performs a deep copy of the database object referred to by this key into a segment pointed to by in_destination. If the copied key includes other keys or has child nodes, they will be recursively copied. Include links will also be copied, however, link targets will not be copied. 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 associated 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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 LineKey class is a smart pointer to a database object. It is a handle to a line inserted via SegmentKey.InsertLine.

Constructor & Destructor Documentation

◆ LineKey() [1/3]

HPS.LineKey.LineKey ( )
inline

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

◆ LineKey() [2/3]

HPS.LineKey.LineKey ( HPS.Key  in_that)
inline

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.

◆ LineKey() [3/3]

HPS.LineKey.LineKey ( HPS.LineKey  in_that)
inline

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

Parameters
in_thatThe source LineKey to copy.

Member Function Documentation

◆ Consume()

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

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

◆ EditPointsByDeletion()

HPS.LineKey HPS.LineKey.EditPointsByDeletion ( ulong  in_offset,
ulong  in_count 
)
inline

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.

◆ EditPointsByInsertion()

HPS.LineKey HPS.LineKey.EditPointsByInsertion ( ulong  in_offset,
HPS.Point []  in_points 
)
inline

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_pointsThe points to insert into the point list at the specified offset.
Returns
A reference to this LineKey.

◆ EditPointsByReplacement()

HPS.LineKey HPS.LineKey.EditPointsByReplacement ( ulong  in_offset,
HPS.Point []  in_points 
)
inline

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_pointsThe points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed.
Returns
A reference to this LineKey.

◆ GetPointCount()

ulong HPS.LineKey.GetPointCount ( )
inline

Retrieves the number of points in this line.

Returns
The number of points in this line.

◆ ObjectType()

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

Copies the source LineKit into this LineKit.

Parameters
in_kitThe source LineKit to copy.

◆ SetPointCoordinateSpace() [1/2]

HPS.LineKey HPS.LineKey.SetPointCoordinateSpace ( ulong []  in_indices,
HPS.Line.CoordinateSpace []  in_spaces 
)
inline

Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object.

Parameters
in_indicesThe list of point indices to unset.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKey.

◆ SetPointCoordinateSpace() [2/2]

HPS.LineKey HPS.LineKey.SetPointCoordinateSpace ( HPS.Line.CoordinateSpace []  in_spaces)
inline

Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object.

Parameters
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKey.

◆ SetPoints() [1/2]

HPS.LineKey HPS.LineKey.SetPoints ( HPS.Point []  in_points)
inline

Sets the points for this LineKey.

Parameters
in_pointsThe points for this LineKey.
Returns
A reference to this LineKey.

◆ SetPoints() [2/2]

HPS.LineKey HPS.LineKey.SetPoints ( HPS.Point []  in_points,
HPS.Line.CoordinateSpace []  in_spaces 
)
inline

Sets the points for this LineKey.

Parameters
in_pointsThe points for this LineKey.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKey.

◆ Show()

void HPS.LineKey.Show ( out HPS.LineKit  out_kit)
inline

Copies this LineKit into the given LineKit.

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

◆ ShowPointCoordinateSpace() [1/2]

bool HPS.LineKey.ShowPointCoordinateSpace ( ulong []  in_indices,
out HPS.Line.CoordinateSpace []  out_spaces 
)
inline

Shows the coordinate space that is being used for the points at the specified indices.

Parameters
in_indicesThe list of point indices to show.
out_spacesThe coordinate spaces for each index specified.
Returns
true if line coordinates could be retrieved for this line false otherwise.

◆ ShowPointCoordinateSpace() [2/2]

bool HPS.LineKey.ShowPointCoordinateSpace ( out HPS.Line.CoordinateSpace []  out_spaces)
inline

Shows the coordinate space that is being used for the points at the specified indices.

Parameters
out_spacesThe coordinate spaces for each all points on this line.
Returns
true if line coordinates could be retrieved for this line false otherwise.

◆ ShowPoints() [1/2]

bool HPS.LineKey.ShowPoints ( out HPS.Point []  out_points)
inline

Shows the points for this LineKey.

Parameters
out_pointsThe points for this LineKey.
Returns
true if points were set, false otherwise.

◆ ShowPoints() [2/2]

bool HPS.LineKey.ShowPoints ( out HPS.Point []  out_points,
out HPS.Line.CoordinateSpace []  out_coordinate_spaces 
)
inline

Shows the points for this LineKey.

Parameters
out_pointsThe points for this LineKey.
out_coordinate_spacesThe coordinate spaces for each point in this line.
Returns
true if points were set, false otherwise.

◆ ShowPointsByList()

bool HPS.LineKey.ShowPointsByList ( ulong []  in_indices,
out HPS.Point []  out_points 
)
inline

Show a subset of the points for this LineKey by list.

Parameters
in_indicesThe list of point indices to show.
out_pointsThe requested points for this LineKey.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByRange()

bool HPS.LineKey.ShowPointsByRange ( ulong  in_start_index,
ulong  in_count,
out HPS.Point []  out_points 
)
inline

Show a subset of the points for this LineKey by range.

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this LineKey.
Returns
true if all requested points were set, false otherwise.

◆ UnsetPointCoordinateSpace() [1/2]

HPS.LineKey HPS.LineKey.UnsetPointCoordinateSpace ( ulong []  in_indices)
inline

Unsets the coordinate space for specified points on this line back to Coordinate.Space.Object.

Parameters
in_indicesThe list of point indices to unset.
Returns
A reference to this LineKey.

◆ UnsetPointCoordinateSpace() [2/2]

HPS.LineKey HPS.LineKey.UnsetPointCoordinateSpace ( )
inline

Unsets the coordinate space for all points on this line back to Coordinate.Space.Object.

Returns
A reference to this LineKey.

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