SphereKit

class HPS::SphereKit : public HPS::Kit 

The SphereKit class is a user space object. It is a kit analog to a SphereKey.

Public Functions

void Consume(SphereKit &in_kit)

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

Parameters: in_kit – The source SphereKit to consume.

virtual bool Empty() const

Indicates whether this SphereKit has any values set on it.

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

bool Equals(SphereKit const &in_kit) const

Check if the source SphereKit is equivalent to this SphereKit.

Parameters: in_kit – The source SphereKit to compare to this SphereKit.
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!=(SphereKit const &in_kit) const

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

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

SphereKit &operator=(SphereKit &&in_that)

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

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

SphereKit &operator=(SphereKit const &in_kit)

Copies the source SphereKit into this SphereKit.

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

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

Check if the source SphereKit is equivalent to this SphereKit.

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

void Set(SphereKit const &in_kit)

Copies the source SphereKit into this SphereKit.

Parameters: in_kit – The source SphereKit to copy.

SphereKit &SetBasis(Vector const &in_vertical, Vector const &in_horizontal)

Sets the basis for the SphereKit.

Parameters

in_vertical – The vector to use as the vertical axis for the SphereKit.
in_horizontal – The vector to use as the horizontal axis for the SphereKit.

Returns

A reference to this SphereKit.

SphereKit &SetCenter(Point const &in_center)

Sets the center point for the SphereKit.

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

SphereKit &SetPriority(int in_priority)

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

SphereKit &SetRadius(float in_radius)

Sets the radius for the SphereKit.

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

SphereKit &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.

SphereKit &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.

SphereKit &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(SphereKit &out_kit) const

Copies this SphereKit into the given SphereKit.

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

bool ShowBasis(Vector &out_vertical, Vector &out_horizontal) const

Shows the basis for the SphereKit.

Parameters

out_vertical – The vector to use as the vertical axis for the SphereKit.
out_horizontal – The vector to use as the horizontal axis for the SphereKit.

Returns

true if a basis was set, false otherwise.

bool ShowCenter(Point &out_center) const

Shows the center point for this SphereKit.

Parameters: out_center – The center point for the SphereKit.
Returns: true if a center point 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 the SphereKit.

Parameters: out_radius – The radius for the SphereKit.
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.

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

SphereKit(SphereKit &&in_that)

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

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

SphereKit(SphereKit const &in_kit)

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

Parameters: in_kit – The source SphereKit to copy.

SphereKit &UnsetAllUserData()

Removes all user data from this kit.

Returns: A reference to this kit.

SphereKit &UnsetBasis()

Removes the basis for this SphereKit.

Returns: A reference to this SphereKit.

SphereKit &UnsetCenter()

Removes the center point for this SphereKit.

Returns: A reference to this SphereKit.

SphereKit &UnsetEverything()

Removes all settings from the SphereKit.

Returns: A reference to this SphereKit.

SphereKit &UnsetPriority()

Removes a drawing priority setting.

Returns: A reference to this object.

SphereKit &UnsetRadius()

Removes the radius for this SphereKit.

Returns: A reference to this SphereKit.

SphereKit &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.

SphereKit &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.

SphereKit &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 ~SphereKit()

Public Static Attributes

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