CircleKit

class HPS::CircleKit : public HPS::Kit 

The HPS::CircleKit class is a user space object. It is a kit analog to a HPS::CircleKey.

Public Functions

CircleKit(): The default constructor creates an empty CircleKit object.

CircleKit(CircleKit &&in_that)

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

Parameters: in_that – An rvalue reference to a CircleKit to take the impl from.

CircleKit(CircleKit const &in_kit)

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

Parameters: in_kit – The source CircleKit to copy.

void Consume(CircleKit &in_kit)

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

Parameters: in_kit – The source CircleKit to consume.

virtual bool Empty() const

Indicates whether this CircleKit has any values set on it.

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

bool Equals(CircleKit const &in_kit) const

Check if the source CircleKit is equivalent to this CircleKit.

Parameters: in_kit – The source CircleKit to compare to this CircleKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(CircleKit const &in_kit) const

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

Parameters: in_kit – The source CircleKit to compare to this CircleKit.
Returns: true if the objects are not equivalent, false otherwise.

CircleKit &operator=(CircleKit &&in_that)

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

Parameters: in_that – An rvalue reference to a CircleKit to take the impl from.
Returns: A reference to this CircleKit.

CircleKit &operator=(CircleKit const &in_kit)

Copies the source CircleKit into this CircleKit.

Parameters: in_kit – The source CircleKit to copy.
Returns: A reference to this CircleKit.

bool operator==(CircleKit const &in_kit) const

Check if the source CircleKit is equivalent to this CircleKit.

Parameters: in_kit – The source CircleKit to compare to this CircleKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(CircleKit const &in_kit)

Copies the source CircleKit into this CircleKit.

Parameters: in_kit – The source CircleKit to copy.

CircleKit &SetCenter(Point const &in_center)

Sets the center point for this CircleKit.

Parameters: in_center – The center point for this CircleKit.
Returns: A reference to this CircleKit.

CircleKit &SetNormal(Vector const &in_normal)

Sets the normal for this CircleKit. This is the normal for the plane in which the circle lies.

Parameters: in_normal – The normal for this CircleKit.
Returns: A reference to this CircleKit.

CircleKit &SetPriority(int const in_priority)

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

See: SubwindowKit::SetPriority()
See: SubwindowKit::SetRenderingAlgorithm()

Parameters: in_priority – The drawing priority, higher priority items are drawn on top of lower priority items.
Returns: A reference to this object.

CircleKit &SetRadius(float in_radius)

Sets the radius for this CircleKit.

Parameters: in_radius – The radius for this CircleKit.
Returns: A reference to this CircleKit.

CircleKit &SetUserData(intptr_t in_index, ByteArray const &in_data)

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

CircleKit &SetUserData(intptr_t in_index, size_t in_bytes, byte const in_data[])

Sets user data on this kit.

Parameters

in_index – The index of the user data to set.
in_bytes – The number of bytes of user data to set.
in_data – The bytes of user data to set.

Returns

A reference to this kit.

CircleKit &SetUserData(IntPtrTArray const &in_indices, ByteArrayArray const &in_data)

Sets user data on this kit.

Parameters

in_indices – An array of user data indices to set.
in_data – An array of bytes of user data to set.

Returns

A reference to this kit.

void Show(CircleKit &out_kit) const

Copies this CircleKit into the given CircleKit.

Parameters: out_kit – The CircleKit to populate with the contents of this CircleKit.

bool ShowCenter(Point &out_center) const

Shows the center point for this CircleKit.

Parameters: out_center – The center point for this CircleKit.
Returns: true if a center point was set, false otherwise.

bool ShowNormal(Vector &out_normal) const

Shows the normal for this CircleKit.

Parameters: out_normal – The normal for this CircleKit.
Returns: true if a normal was set, false otherwise.

bool ShowPriority(int &out_priority) const

Shows the drawing priority.

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

bool ShowRadius(float &out_radius) const

Shows the radius for this CircleKit.

Parameters: out_radius – The radius for this CircleKit.
Returns: true if a radius was set, false otherwise.

bool ShowUserData(intptr_t in_index, ByteArray &out_data) const

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

Parameters

in_index – The index of the user data to show.
out_data – The user data at the given index.

Returns

true if there is user data at the given index, false otherwise.

bool ShowUserData(IntPtrTArray &out_indices, ByteArrayArray &out_data) const

Shows all user data for this kit.

Parameters

out_indices – An array of all user data indices set on this kit.
out_data – An array of all user data set on this kit.

Returns

true if there is user data on this kit, false otherwise.

size_t ShowUserDataCount() const: Get the number of user data indices set on this kit.

bool ShowUserDataIndices(IntPtrTArray &out_indices) const

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

Parameters: out_indices – The user data indices set on this kit.
Returns: The number of user data indices set on this kit.

CircleKit &UnsetAllUserData()

Removes all user data from this kit.

Returns: A reference to this kit.

CircleKit &UnsetCenter()

Removes the center point for this CircleKit.

Returns: A reference to this CircleKit.

CircleKit &UnsetEverything()

Removes all settings from the CircleKit.

Returns: A reference to this CircleKit.

CircleKit &UnsetNormal()

Removes the normal for this CircleKit.

Returns: A reference to this CircleKit.

CircleKit &UnsetPriority()

Removes a drawing priority setting.

Returns: A reference to this object.

CircleKit &UnsetRadius()

Removes the radius for this CircleKit.

Returns: A reference to this CircleKit.

CircleKit &UnsetUserData(intptr_t in_index)

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

Parameters: in_index – The index of the user data to remove.
Returns: A reference to this kit.

CircleKit &UnsetUserData(IntPtrTArray const &in_indices)

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

Parameters: in_indices – The indices of the user data to remove.
Returns: A reference to this kit.

CircleKit &UnsetUserData(size_t in_count, intptr_t const in_indices[])

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

Parameters

in_count – The size of the following array.
in_indices – The indices of the user data to remove.

Returns

A reference to this kit.

virtual ~CircleKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CircleKit