#include <hps.h>

Inheritance diagram for HPS::LineKit:
HPS::Kit HPS::Object

Public Member Functions

void Consume (LineKit &in_kit)
 
LineKitEditPointsByDeletion (size_t in_offset, size_t in_count)
 
LineKitEditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[])
 
LineKitEditPointsByInsertion (size_t in_offset, PointArray const &in_points)
 
LineKitEditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[])
 
LineKitEditPointsByReplacement (size_t in_offset, PointArray const &in_points)
 
bool Empty () const
 
bool Equals (LineKit const &in_kit) const
 
size_t GetPointCount () const
 
 LineKit ()
 
 LineKit (LineKit const &in_kit)
 
 LineKit (LineKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (LineKit const &in_kit) const
 
LineKitoperator= (LineKit &&in_that)
 
LineKitoperator= (LineKit const &in_kit)
 
bool operator== (LineKit const &in_kit) const
 
void Set (LineKit const &in_kit)
 
LineKitSetPointCoordinateSpace (size_t in_count, size_t const in_indices[], Line::CoordinateSpace const in_spaces[])
 
LineKitSetPointCoordinateSpace (SizeTArray const &in_indices, LineCoordinateSpaceArray const &in_spaces)
 
LineKitSetPointCoordinateSpace (LineCoordinateSpaceArray const &in_spaces)
 
LineKitSetPointCoordinateSpace (size_t in_count, Line::CoordinateSpace const in_spaces[])
 
LineKitSetPoints (PointArray const &in_points)
 
LineKitSetPoints (size_t in_count, Point const in_points [])
 
LineKitSetPoints (PointArray const &in_points, LineCoordinateSpaceArray const &in_spaces)
 
LineKitSetPoints (size_t in_count, Point const in_points[], Line::CoordinateSpace const in_spaces[])
 
LineKitSetPriority (int in_priority)
 
LineKitSetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
LineKitSetUserData (intptr_t in_index, ByteArray const &in_data)
 
LineKitSetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
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
 
bool ShowPriority (int &out_priority) 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
 
LineKitUnsetAllUserData ()
 
LineKitUnsetEverything ()
 
LineKitUnsetPointCoordinateSpace (SizeTArray const &in_indices)
 
LineKitUnsetPointCoordinateSpace (size_t in_count, size_t const in_indices[])
 
LineKitUnsetPointCoordinateSpace ()
 
LineKitUnsetPoints ()
 
LineKitUnsetPriority ()
 
LineKitUnsetUserData (intptr_t in_index)
 
LineKitUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
LineKitUnsetUserData (IntPtrTArray const &in_indices)
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::LineKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The LineKit class is a user space object. It is a kit analog to a LineKey.

Constructor & Destructor Documentation

◆ LineKit() [1/3]

HPS::LineKit::LineKit ( )

The default constructor creates an empty LineKit object.

◆ LineKit() [2/3]

HPS::LineKit::LineKit ( LineKit const &  in_kit)

The copy constructor creates a new LineKit object that contains the same settings as the source LineKit.

Parameters
in_kitThe source LineKit to copy.

◆ LineKit() [3/3]

HPS::LineKit::LineKit ( LineKit &&  in_that)

The move constructor creates a LineKit by transferring the underlying impl of the rvalue reference to this LineKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a LineKit to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::LineKit::Consume ( LineKit in_kit)

Copies the source LineKit into this LineKit and resets the source kit.

Parameters
in_kitThe source LineKit to consume.

◆ EditPointsByDeletion()

LineKit& HPS::LineKit::EditPointsByDeletion ( size_t  in_offset,
size_t  in_count 
)

Removes points from the point list for this LineKit.

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

◆ EditPointsByInsertion() [1/2]

LineKit& HPS::LineKit::EditPointsByInsertion ( size_t  in_offset,
size_t  in_count,
Point const  in_points[] 
)

Adds points to the point list for this LineKit.

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

◆ EditPointsByInsertion() [2/2]

LineKit& HPS::LineKit::EditPointsByInsertion ( size_t  in_offset,
PointArray const &  in_points 
)

Adds points to the point list for this LineKit.

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

◆ EditPointsByReplacement() [1/2]

LineKit& HPS::LineKit::EditPointsByReplacement ( size_t  in_offset,
size_t  in_count,
Point const  in_points[] 
)

Replaces points in the point list for this LineKit.

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

◆ EditPointsByReplacement() [2/2]

LineKit& HPS::LineKit::EditPointsByReplacement ( size_t  in_offset,
PointArray const &  in_points 
)

Replaces points in the point list for this LineKit.

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

◆ Empty()

bool HPS::LineKit::Empty ( ) const
virtual

Indicates whether this LineKit has any values set on it.

Returns
true if no values are set on this LineKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::LineKit::Equals ( LineKit const &  in_kit) const

Check if the source LineKit is equivalent to this LineKit.

Parameters
in_kitThe source LineKit to compare to this LineKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetPointCount()

size_t HPS::LineKit::GetPointCount ( ) const

Retrieves the number of points in this line.

Returns
The number of points in this line.

◆ ObjectType()

HPS::Type HPS::LineKit::ObjectType ( ) const
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::Kit.

◆ operator!=()

bool HPS::LineKit::operator!= ( LineKit const &  in_kit) const

Check if the source LineKit is not equivalent to this LineKit.

Parameters
in_kitThe source LineKit to compare to this LineKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

LineKit& HPS::LineKit::operator= ( LineKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this LineKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an LineKit to take the impl from.
Returns
A reference to this LineKit.

◆ operator=() [2/2]

LineKit& HPS::LineKit::operator= ( LineKit const &  in_kit)

Copies the source LineKit into this LineKit.

Parameters
in_kitThe source LineKit to copy.
Returns
A reference to this LineKit.

◆ operator==()

bool HPS::LineKit::operator== ( LineKit const &  in_kit) const

Check if the source LineKit is equivalent to this LineKit.

Parameters
in_kitThe source LineKit to compare to this LineKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::LineKit::Set ( LineKit const &  in_kit)

Copies the source LineKit into this LineKit.

Parameters
in_kitThe source LineKit to copy.

◆ SetPointCoordinateSpace() [1/4]

LineKit& HPS::LineKit::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_countThe number of points to unset.
in_indicesThe list of point indices to unset.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPointCoordinateSpace() [2/4]

LineKit& HPS::LineKit::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_indicesThe list of point indices to unset.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPointCoordinateSpace() [3/4]

LineKit& HPS::LineKit::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_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPointCoordinateSpace() [4/4]

LineKit& HPS::LineKit::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_countSize of the following array.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPoints() [1/4]

LineKit& HPS::LineKit::SetPoints ( PointArray const &  in_points)

Sets the points for this LineKit.

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

◆ SetPoints() [2/4]

LineKit& HPS::LineKit::SetPoints ( size_t  in_count,
Point const  in_points[] 
)

Sets the points for this LineKit.

Parameters
in_countSize of the following array.
in_pointsThe points for this LineKit.
Returns
A reference to this LineKit.

◆ SetPoints() [3/4]

LineKit& HPS::LineKit::SetPoints ( PointArray const &  in_points,
LineCoordinateSpaceArray const &  in_spaces 
)

Sets the points for this LineKit.

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

◆ SetPoints() [4/4]

LineKit& HPS::LineKit::SetPoints ( size_t  in_count,
Point const  in_points[],
Line::CoordinateSpace const  in_spaces[] 
)

Sets the points for this LineKit.

Parameters
in_countSize of the following array.
in_pointsThe points for this LineKit.
in_spacesThe coordinate spaces for each point in the line.
Returns
A reference to this LineKit.

◆ SetPriority()

LineKit& HPS::LineKit::SetPriority ( int  in_priority)

Assigns a specific drawing priority value to the LineKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit::SetPriority()
SubwindowKit::SetRenderingAlgorithm()

◆ SetUserData() [1/3]

LineKit& HPS::LineKit::SetUserData ( intptr_t  in_index,
size_t  in_bytes,
byte const  in_data[] 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

LineKit& HPS::LineKit::SetUserData ( intptr_t  in_index,
ByteArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

LineKit& HPS::LineKit::SetUserData ( IntPtrTArray const &  in_indices,
ByteArrayArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ Show()

void HPS::LineKit::Show ( LineKit out_kit) const

Copies this LineKit into the given LineKit.

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

◆ ShowPointCoordinateSpace() [1/3]

bool HPS::LineKit::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_countThe number of points to show.
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/3]

bool HPS::LineKit::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_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() [3/3]

bool HPS::LineKit::ShowPointCoordinateSpace ( LineCoordinateSpaceArray out_spaces) const

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::LineKit::ShowPoints ( PointArray out_points) const

Shows the points for this LineKit.

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

◆ ShowPoints() [2/2]

bool HPS::LineKit::ShowPoints ( PointArray out_points,
LineCoordinateSpaceArray out_coordinate_spaces 
) const

Shows the points for this LineKit.

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

◆ ShowPointsByList() [1/2]

bool HPS::LineKit::ShowPointsByList ( SizeTArray const &  in_indices,
PointArray out_points 
) const

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

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

◆ ShowPointsByList() [2/2]

bool HPS::LineKit::ShowPointsByList ( size_t  in_count,
size_t const  in_indices[],
PointArray out_points 
) const

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

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

◆ ShowPointsByRange()

bool HPS::LineKit::ShowPointsByRange ( size_t  in_start_index,
size_t  in_count,
PointArray out_points 
) const

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

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

◆ ShowPriority()

bool HPS::LineKit::ShowPriority ( int &  out_priority) const

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowUserData() [1/2]

bool HPS::LineKit::ShowUserData ( intptr_t  in_index,
ByteArray out_data 
) const

Shows the user data at a given index for this kit.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS::LineKit::ShowUserData ( IntPtrTArray out_indices,
ByteArrayArray out_data 
) const

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

size_t HPS::LineKit::ShowUserDataCount ( ) const

Get the number of user data indices set on this kit.

◆ ShowUserDataIndices()

bool HPS::LineKit::ShowUserDataIndices ( IntPtrTArray out_indices) const

Shows the indices of all user data set on this kit.

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ UnsetAllUserData()

LineKit& HPS::LineKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

LineKit& HPS::LineKit::UnsetEverything ( )

Removes all settings from the LineKit.

Returns
A reference to this LineKit.

◆ UnsetPointCoordinateSpace() [1/3]

LineKit& HPS::LineKit::UnsetPointCoordinateSpace ( SizeTArray const &  in_indices)

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

◆ UnsetPointCoordinateSpace() [2/3]

LineKit& HPS::LineKit::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_countThe number of points to unset.
in_indicesThe list of point indices to unset.
Returns
A reference to this LineKit.

◆ UnsetPointCoordinateSpace() [3/3]

LineKit& HPS::LineKit::UnsetPointCoordinateSpace ( )

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

Returns
A reference to this LineKit.

◆ UnsetPoints()

LineKit& HPS::LineKit::UnsetPoints ( )

Removes the points for this LineKit.

Returns
A reference to this LineKit.

◆ UnsetPriority()

LineKit& HPS::LineKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/3]

LineKit& HPS::LineKit::UnsetUserData ( intptr_t  in_index)

Removes the user data at the given index from this kit.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/3]

LineKit& HPS::LineKit::UnsetUserData ( size_t  in_count,
intptr_t const  in_indices[] 
)

Removes the user data at the given indices from this kit.

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [3/3]

LineKit& HPS::LineKit::UnsetUserData ( IntPtrTArray const &  in_indices)

Removes the user data at the given indices from this kit.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

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