#include <hps.h>

Inheritance diagram for HPS::MarkerKit:
HPS::Kit HPS::Object

Public Member Functions

void Consume (MarkerKit &in_kit)
 
bool Empty () const
 
bool Equals (MarkerKit const &in_kit) const
 
 MarkerKit ()
 
 MarkerKit (MarkerKit const &in_kit)
 
 MarkerKit (MarkerKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (MarkerKit const &in_kit) const
 
MarkerKitoperator= (MarkerKit &&in_that)
 
MarkerKitoperator= (MarkerKit const &in_kit)
 
bool operator== (MarkerKit const &in_kit) const
 
void Set (MarkerKit const &in_kit)
 
MarkerKitSetPoint (Point const &in_point)
 
MarkerKitSetPriority (int in_priority)
 
MarkerKitSetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
MarkerKitSetUserData (intptr_t in_index, ByteArray const &in_data)
 
MarkerKitSetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
void Show (MarkerKit &out_kit) const
 
bool ShowPoint (HPS::Point &out_point) 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
 
MarkerKitUnsetAllUserData ()
 
MarkerKitUnsetEverything ()
 
MarkerKitUnsetPoint ()
 
MarkerKitUnsetPriority ()
 
MarkerKitUnsetUserData (intptr_t in_index)
 
MarkerKitUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
MarkerKitUnsetUserData (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::MarkerKit
 
- 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 MarkerKit class is a user space object. It is a kit analog to a MarkerKey.

Constructor & Destructor Documentation

◆ MarkerKit() [1/3]

HPS::MarkerKit::MarkerKit ( )

The default constructor creates an empty MarkerKit object.

◆ MarkerKit() [2/3]

HPS::MarkerKit::MarkerKit ( MarkerKit const &  in_kit)

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

Parameters
in_kitThe source MarkerKit to copy.

◆ MarkerKit() [3/3]

HPS::MarkerKit::MarkerKit ( MarkerKit &&  in_that)

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

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

Member Function Documentation

◆ Consume()

void HPS::MarkerKit::Consume ( MarkerKit in_kit)

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

Parameters
in_kitThe source LineKit to consume.

◆ Empty()

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

Indicates whether this MarkerKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source MarkerKit is equivalent to this MarkerKit.

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

◆ ObjectType()

HPS::Type HPS::MarkerKit::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::MarkerKit::operator!= ( MarkerKit const &  in_kit) const

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

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

◆ operator=() [1/2]

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

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

Parameters
in_thatAn rvalue reference to a MarkerKit to take the impl from.
Returns
A reference to this MarkerKit.

◆ operator=() [2/2]

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

Copies the source MarkerKit into this MarkerKit.

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

◆ operator==()

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

Check if the source MarkerKit is equivalent to this MarkerKit.

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

◆ Set()

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

Copies the source MarkerKit into this MarkerKit.

Parameters
in_kitThe source MarkerKit to copy.

◆ SetPoint()

MarkerKit& HPS::MarkerKit::SetPoint ( Point const &  in_point)

Sets the point for this MarkerKit.

Parameters
in_pointThe point for this MarkerKit.
Returns
A reference to this MarkerKit.

◆ SetPriority()

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

Assigns a specific drawing priority value to the MarkerKit. 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]

MarkerKit& HPS::MarkerKit::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]

MarkerKit& HPS::MarkerKit::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]

MarkerKit& HPS::MarkerKit::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::MarkerKit::Show ( MarkerKit out_kit) const

Copies this MarkerKit into the given MarkerKit.

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

◆ ShowPoint()

bool HPS::MarkerKit::ShowPoint ( HPS::Point out_point) const

Shows the point for this MarkerKit.

Parameters
out_pointThe point for this MarkerKit.
Returns
true if a point was set, false otherwise.

◆ ShowPriority()

bool HPS::MarkerKit::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::MarkerKit::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::MarkerKit::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::MarkerKit::ShowUserDataCount ( ) const

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

◆ ShowUserDataIndices()

bool HPS::MarkerKit::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()

MarkerKit& HPS::MarkerKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

MarkerKit& HPS::MarkerKit::UnsetEverything ( )

Removes all settings from the MarkerKit.

Returns
A reference to this MarkerKit.

◆ UnsetPoint()

MarkerKit& HPS::MarkerKit::UnsetPoint ( )

Removes the point for the MarkerKit.

Returns
A reference to this MarkerKit.

◆ UnsetPriority()

MarkerKit& HPS::MarkerKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/3]

MarkerKit& HPS::MarkerKit::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]

MarkerKit& HPS::MarkerKit::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]

MarkerKit& HPS::MarkerKit::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: