#include <hps.h>

Public Member Functions | |
void | Consume (LineKit &in_kit) |
LineKey & | EditPointsByDeletion (size_t in_offset, size_t in_count) |
LineKey & | EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[]) |
LineKey & | EditPointsByInsertion (size_t in_offset, PointArray const &in_points) |
LineKey & | EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[]) |
LineKey & | EditPointsByReplacement (size_t in_offset, PointArray const &in_points) |
size_t | GetPointCount () const |
LineKey () | |
LineKey (Key const &in_that) | |
LineKey (LineKey const &in_that) | |
LineKey (LineKey &&in_that) | |
HPS::Type | ObjectType () const |
LineKey & | operator= (LineKey const &in_that) |
LineKey & | operator= (LineKey &&in_that) |
void | Set (LineKit const &in_kit) |
LineKey & | SetPointCoordinateSpace (size_t in_count, size_t const in_indices[], Line::CoordinateSpace const in_spaces[]) |
LineKey & | SetPointCoordinateSpace (SizeTArray const &in_indices, LineCoordinateSpaceArray const &in_spaces) |
LineKey & | SetPointCoordinateSpace (LineCoordinateSpaceArray const &in_spaces) |
LineKey & | SetPointCoordinateSpace (size_t in_count, Line::CoordinateSpace const in_spaces[]) |
LineKey & | SetPoints (PointArray const &in_points) |
LineKey & | SetPoints (size_t in_count, Point const in_points[]) |
LineKey & | SetPoints (PointArray const &in_points, LineCoordinateSpaceArray const &in_spaces) |
LineKey & | SetPoints (size_t in_count, Point const in_points[], Line::CoordinateSpace const in_spaces[]) |
void | Show (LineKit &out_kit) const |
bool | ShowPointCoordinateSpace (size_t in_count, size_t const in_indices[], LineCoordinateSpaceArray &out_spaces) const |
bool | ShowPointCoordinateSpace (SizeTArray const &in_indices, LineCoordinateSpaceArray &out_spaces) const |
bool | ShowPointCoordinateSpace (LineCoordinateSpaceArray &out_spaces) const |
bool | ShowPoints (PointArray &out_points) const |
bool | ShowPoints (PointArray &out_points, LineCoordinateSpaceArray &out_coordinate_spaces) const |
bool | ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const |
bool | ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const |
bool | ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const |
LineKey & | UnsetPointCoordinateSpace (SizeTArray const &in_indices) |
LineKey & | UnsetPointCoordinateSpace (size_t in_count, size_t const in_indices[]) |
LineKey & | UnsetPointCoordinateSpace () |
![]() | |
GeometryKey () | |
GeometryKey (Key const &in_that) | |
GeometryKey (GeometryKey const &in_that) | |
GeometryKey (GeometryKey &&in_that) | |
GeometryKey & | operator= (GeometryKey const &in_that) |
GeometryKey & | operator= (GeometryKey &&in_that) |
GeometryKey & | SetPriority (int in_priority) |
GeometryKey & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
GeometryKey & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
GeometryKey & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
bool | ShowBounding (BoundingKit &out_kit) const |
bool | ShowPriority (int &out_priority) const |
size_t | ShowReferrers (SegmentKeyArray &out_segments) const |
size_t | ShowReferrers (ReferenceKeyArray &out_references) const |
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
size_t | ShowUserDataCount () const |
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
GeometryKey & | UnsetAllUserData () |
GeometryKey & | UnsetPriority () |
GeometryKey & | UnsetUserData (intptr_t in_index) |
GeometryKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
GeometryKey & | UnsetUserData (IntPtrTArray const &in_indices) |
![]() | |
virtual void | Assign (Key const &in_that) |
Key | CopyTo (SegmentKey const &in_destination) const |
void | Delete () |
bool | Equals (Key const &in_that) const |
size_t | GetHash () const |
bool | HasOwner () const |
Key () | |
Key (Key const &in_that) | |
Key (Control const &in_control) | |
Key (Key &&in_that) | |
void | MoveTo (SegmentKey const &in_new_owner) |
bool | operator!= (Key const &in_that) const |
Key & | operator= (Key &&in_that) |
Key & | operator= (Key const &in_that) |
bool | operator== (Key const &in_that) const |
SegmentKey | Owner () const |
SegmentKey | Up () const |
virtual | ~Key () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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 | ( | ) |
|
explicit |
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.
- Parameters
-
in_name The source Key to copy.
HPS::LineKey::LineKey | ( | LineKey const & | in_that | ) |
HPS::LineKey::LineKey | ( | LineKey && | in_that | ) |
Member Function Documentation
void HPS::LineKey::Consume | ( | LineKit & | in_kit | ) |
LineKey& HPS::LineKey::EditPointsByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
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.
LineKey& HPS::LineKey::EditPointsByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
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_count Size of the following array. in_points The points to insert into the point list at the specified offset.
- Returns
- A reference to this LineKey.
LineKey& HPS::LineKey::EditPointsByInsertion | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
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.
LineKey& HPS::LineKey::EditPointsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
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_count Size of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed. in_points The points to use to replace those in the point list at the specified offset.
- Returns
- A reference to this LineKey.
LineKey& HPS::LineKey::EditPointsByReplacement | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
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.
size_t HPS::LineKey::GetPointCount | ( | ) | const |
Retrieves the number of points in this line.
- Returns
- The number of points in this line.
|
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::LineKey::Set | ( | LineKit const & | in_kit | ) |
LineKey& HPS::LineKey::SetPointCoordinateSpace | ( | size_t | in_count, |
size_t const | in_indices[], | ||
Line::CoordinateSpace const | in_spaces[] | ||
) |
Sets the coordinate space to use for each point of this line. The default is Line::CoordinateSpace::Object.
- Parameters
-
in_count The number of points to unset. 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.
LineKey& HPS::LineKey::SetPointCoordinateSpace | ( | SizeTArray const & | in_indices, |
LineCoordinateSpaceArray const & | in_spaces | ||
) |
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.
LineKey& HPS::LineKey::SetPointCoordinateSpace | ( | LineCoordinateSpaceArray const & | in_spaces | ) |
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.
LineKey& HPS::LineKey::SetPointCoordinateSpace | ( | size_t | in_count, |
Line::CoordinateSpace const | in_spaces[] | ||
) |
Sets the coordinate space to use for each point of this line. The default is Line::CoordinateSpace::Object.
- Parameters
-
in_count Size of the following array. in_spaces The coordinate spaces for each point in the line.
- Returns
- A reference to this LineKey.
LineKey& HPS::LineKey::SetPoints | ( | PointArray const & | in_points | ) |
LineKey& HPS::LineKey::SetPoints | ( | PointArray const & | in_points, |
LineCoordinateSpaceArray const & | in_spaces | ||
) |
void HPS::LineKey::Show | ( | LineKit & | out_kit | ) | const |
bool HPS::LineKey::ShowPointCoordinateSpace | ( | size_t | in_count, |
size_t const | in_indices[], | ||
LineCoordinateSpaceArray & | out_spaces | ||
) | const |
Shows the coordinate space that is being used for the points at the specified indices.
- Parameters
-
in_count The number of points to show. 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.
bool HPS::LineKey::ShowPointCoordinateSpace | ( | SizeTArray const & | in_indices, |
LineCoordinateSpaceArray & | out_spaces | ||
) | const |
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.
bool HPS::LineKey::ShowPointCoordinateSpace | ( | LineCoordinateSpaceArray & | out_spaces | ) | const |
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.
bool HPS::LineKey::ShowPoints | ( | PointArray & | out_points | ) | const |
bool HPS::LineKey::ShowPoints | ( | PointArray & | out_points, |
LineCoordinateSpaceArray & | out_coordinate_spaces | ||
) | const |
bool HPS::LineKey::ShowPointsByList | ( | SizeTArray const & | in_indices, |
PointArray & | out_points | ||
) | const |
bool HPS::LineKey::ShowPointsByList | ( | size_t | in_count, |
size_t const | in_indices[], | ||
PointArray & | out_points | ||
) | const |
bool HPS::LineKey::ShowPointsByRange | ( | size_t | in_start_index, |
size_t | in_count, | ||
PointArray & | out_points | ||
) | const |
LineKey& HPS::LineKey::UnsetPointCoordinateSpace | ( | SizeTArray const & | in_indices | ) |
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.
LineKey& HPS::LineKey::UnsetPointCoordinateSpace | ( | size_t | in_count, |
size_t const | in_indices[] | ||
) |
Unsets the coordinate space for specified points on this line back to Coordinate::Space::Object.
- Parameters
-
in_count The number of points to unset. in_indices The list of point indices to unset.
- Returns
- A reference to this LineKey.
LineKey& HPS::LineKey::UnsetPointCoordinateSpace | ( | ) |
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:
- include/hps.h