|
void | Consume (HPS.LineKit in_kit) |
|
override void | Dispose () |
|
HPS.LineKey | EditPointsByDeletion (ulong in_offset, ulong in_count) |
|
HPS.LineKey | EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points) |
|
HPS.LineKey | EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points) |
|
ulong | GetPointCount () |
|
| LineKey () |
|
| LineKey (HPS.Key in_that) |
|
| LineKey (HPS.LineKey in_that) |
|
override HPS.Type | ObjectType () |
|
void | Set (HPS.LineKit in_kit) |
|
HPS.LineKey | SetPointCoordinateSpace (ulong[] in_indices, HPS.Line.CoordinateSpace[] in_spaces) |
|
HPS.LineKey | SetPointCoordinateSpace (HPS.Line.CoordinateSpace[] in_spaces) |
|
HPS.LineKey | SetPoints (HPS.Point[] in_points) |
|
HPS.LineKey | SetPoints (HPS.Point[] in_points, HPS.Line.CoordinateSpace[] in_spaces) |
|
void | Show (out HPS.LineKit out_kit) |
|
bool | ShowPointCoordinateSpace (ulong[] in_indices, out HPS.Line.CoordinateSpace[] out_spaces) |
|
bool | ShowPointCoordinateSpace (out HPS.Line.CoordinateSpace[] out_spaces) |
|
bool | ShowPoints (out HPS.Point[] out_points) |
|
bool | ShowPoints (out HPS.Point[] out_points, out HPS.Line.CoordinateSpace[] out_coordinate_spaces) |
|
bool | ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points) |
|
bool | ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points) |
|
HPS.LineKey | UnsetPointCoordinateSpace (ulong[] in_indices) |
|
HPS.LineKey | UnsetPointCoordinateSpace () |
|
| 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) |
|
virtual void | Assign (HPS.Key in_that) |
|
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
|
void | Delete () |
|
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) |
|
HPS.SegmentKey | Owner () |
|
HPS.SegmentKey | Up () |
|
virtual bool | Empty () |
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
|
bool | HasType (HPS.Type in_mask) |
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
|
virtual HPS.Type | Type () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static bool | operator!= (HPS.Key a, HPS.Key b) |
|
static bool | operator== (HPS.Key a, HPS.Key b) |
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The LineKey class is a smart pointer to a database object. It is a handle to a line inserted via SegmentKey.InsertLine.
◆ LineKey() [1/3]
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]
The copy constructor creates a LineKey object that shares the underlying smart-pointer of the source LineKey.
- Parameters
-
◆ Consume()
Completely replaces all settings on this LineKey with those set on the specified kit and resets the kit.
- Parameters
-
in_kit | The 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_offset | The 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_count | The 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()
Adds points to the point list for this LineKey.
- Parameters
-
in_offset | The 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_points | The points to insert into the point list at the specified offset. |
- Returns
- A reference to this LineKey.
◆ EditPointsByReplacement()
Replaces points in the point list for this LineKey.
- Parameters
-
in_offset | The 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_points | The 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()
◆ SetPointCoordinateSpace() [1/2]
Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object.
- Parameters
-
in_indices | The list of point indices to unset. |
in_spaces | The coordinate spaces for each point in the line. |
- Returns
- A reference to this LineKey.
◆ SetPointCoordinateSpace() [2/2]
Sets the coordinate space to use for each point of this line. The default is Line.CoordinateSpace.Object.
- Parameters
-
in_spaces | The coordinate spaces for each point in the line. |
- Returns
- A reference to this LineKey.
◆ SetPoints() [1/2]
Sets the points for this LineKey.
- Parameters
-
in_points | The points for this LineKey. |
- Returns
- A reference to this LineKey.
◆ SetPoints() [2/2]
Sets the points for this LineKey.
- Parameters
-
in_points | The points for this LineKey. |
in_spaces | The coordinate spaces for each point in the line. |
- Returns
- A reference to this LineKey.
◆ Show()
◆ ShowPointCoordinateSpace() [1/2]
Shows the coordinate space that is being used for the points at the specified indices.
- Parameters
-
in_indices | The list of point indices to show. |
out_spaces | The coordinate spaces for each index specified. |
- Returns
- true if line coordinates could be retrieved for this line false otherwise.
◆ ShowPointCoordinateSpace() [2/2]
Shows the coordinate space that is being used for the points at the specified indices.
- Parameters
-
out_spaces | The 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_points | The points for this LineKey. |
- Returns
- true if points were set, false otherwise.
◆ ShowPoints() [2/2]
Shows the points for this LineKey.
- Parameters
-
out_points | The points for this LineKey. |
out_coordinate_spaces | The 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_indices | The list of point indices to show. |
out_points | The 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_index | The first point to show. |
in_count | The number of points to show. |
out_points | The 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_indices | The list of point indices to unset. |
- Returns
- A reference to this LineKey.
◆ UnsetPointCoordinateSpace() [2/2]
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.LineKey.cs