#include <hps.h>

Inheritance diagram for HPS::EllipseKit:

Public Member Functions
void	Consume (EllipseKit &in_kit)

	EllipseKit ()

	EllipseKit (EllipseKit const &in_kit)

	EllipseKit (EllipseKit &&in_that)

bool	Empty () const

bool	Equals (EllipseKit const &in_kit) const

HPS::Type	ObjectType () const

bool	operator!= (EllipseKit const &in_kit) const

EllipseKit &	operator= (EllipseKit &&in_that)

EllipseKit &	operator= (EllipseKit const &in_kit)

bool	operator== (EllipseKit const &in_kit) const

void	Set (EllipseKit const &in_kit)

EllipseKit &	SetCenter (Point const &in_center)

EllipseKit &	SetMajor (Point const &in_major)

EllipseKit &	SetMinor (Point const &in_minor)

EllipseKit &	SetPriority (int in_priority)

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

EllipseKit &	SetUserData (intptr_t in_index, ByteArray const &in_data)

EllipseKit &	SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)

void	Show (EllipseKit &out_kit) const

bool	ShowCenter (Point &out_center) const

bool	ShowMajor (Point &out_major) const

bool	ShowMinor (Point &out_minor) 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

EllipseKit &	UnsetAllUserData ()

EllipseKit &	UnsetCenter ()

EllipseKit &	UnsetEverything ()

EllipseKit &	UnsetMajor ()

EllipseKit &	UnsetMinor ()

EllipseKit &	UnsetPriority ()

EllipseKit &	UnsetUserData (intptr_t in_index)

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

EllipseKit &	UnsetUserData (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)

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::EllipseKit

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)

Kit &	operator= (Kit &&in_that)

Detailed Description

The EllipseKit class is a user space object. It is the kit analog to an EllipseKey.

Constructor & Destructor Documentation

◆ EllipseKit() [1/3]

HPS::EllipseKit::EllipseKit ( )

The default constructor creates an empty EllipseKit object.

◆ EllipseKit() [2/3]

HPS::EllipseKit::EllipseKit ( EllipseKit const & in_kit )

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

Parameters

in_kit The source EllipseKit to copy.

◆ EllipseKit() [3/3]

HPS::EllipseKit::EllipseKit ( EllipseKit && in_that )

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

Parameters

in_that An rvalue reference to an EllipseKit to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::EllipseKit::Consume ( EllipseKit & in_kit )

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

Parameters

in_kit The source EllipseKit to consume.

◆ Empty()

bool HPS::EllipseKit::Empty ( ) const

virtual

Indicates whether this EllipseKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source EllipseKit is equivalent to this EllipseKit.

Parameters

in_kit The source EllipseKit to compare to this EllipseKit.

Returns: true if the objects are equivalent, false otherwise.

◆ ObjectType()

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

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

Parameters

in_kit The source EllipseKit to compare to this EllipseKit.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to an EllipseKit to take the impl from.

Returns: A reference to this EllipseKit.

◆ operator=() [2/2]

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

Copies the source EllipseKit into this EllipseKit.

Parameters

in_kit The source EllipseKit to copy.

Returns: A reference to this EllipseKit.

◆ operator==()

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

Check if the source EllipseKit is equivalent to this EllipseKit.

Parameters

in_kit The source EllipseKit to compare to this EllipseKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source EllipseKit into this EllipseKit.

Parameters

in_kit The source EllipseKit to copy.

◆ SetCenter()

EllipseKit& HPS::EllipseKit::SetCenter ( Point const & in_center )

Sets the center point for the ellipse.

Parameters

in_center The center point for the ellipse.

Returns: A reference to this EllipseKit.

◆ SetMajor()

EllipseKit& HPS::EllipseKit::SetMajor ( Point const & in_major )

Sets the intersection point of the major axis and the ellipse.

Parameters

in_major The intersection point of the major axis and the ellipse.

Returns: A reference to this EllipseKit.

◆ SetMinor()

EllipseKit& HPS::EllipseKit::SetMinor ( Point const & in_minor )

Sets the intersection point of the minor axis and the ellipse.

Parameters

in_minor The intersection point of the minor axis and the ellipse.

Returns: A reference to this EllipseKit.

◆ SetPriority()

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

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

EllipseKit& HPS::EllipseKit::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.

◆ SetUserData() [2/3]

EllipseKit& HPS::EllipseKit::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.

◆ SetUserData() [3/3]

EllipseKit& HPS::EllipseKit::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.

◆ Show()

void HPS::EllipseKit::Show ( EllipseKit & out_kit ) const

Copies this EllipseKit into the given EllipseKit.

Parameters

out_kit The EllipseKit to populate with the contents of this EllipseKit.

◆ ShowCenter()

bool HPS::EllipseKit::ShowCenter ( Point & out_center ) const

Shows the center point for the ellipse.

Parameters

out_center The center point for the ellipse.

Returns: true if a center was set, false otherwise.

◆ ShowMajor()

bool HPS::EllipseKit::ShowMajor ( Point & out_major ) const

Shows the intersection point of the major axis and the ellipse.

Parameters

out_major The intersection point of the major axis and the ellipse.

Returns: true if an intersection point with the major axis was set, false otherwise.

◆ ShowMinor()

bool HPS::EllipseKit::ShowMinor ( Point & out_minor ) const

Shows the intersection point of the minor axis and the ellipse.

Parameters

out_minor The intersection point of the minor axis and the ellipse.

Returns: true if an intersection point with the minor axis was set, false otherwise.

◆ ShowPriority()

bool HPS::EllipseKit::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.

◆ ShowUserData() [1/2]

bool HPS::EllipseKit::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.

◆ ShowUserData() [2/2]

bool HPS::EllipseKit::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.

◆ ShowUserDataCount()

size_t HPS::EllipseKit::ShowUserDataCount ( ) const

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

◆ ShowUserDataIndices()

bool HPS::EllipseKit::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.

◆ UnsetAllUserData()

EllipseKit& HPS::EllipseKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns: A reference to this kit.

◆ UnsetCenter()

EllipseKit& HPS::EllipseKit::UnsetCenter ( )

Removes the center point for the ellipse.

Returns: A reference to this EllipseKit.

◆ UnsetEverything()

EllipseKit& HPS::EllipseKit::UnsetEverything ( )

Removes all settings from this EllipseKit.

Returns: A reference to this EllipseKit.

◆ UnsetMajor()

EllipseKit& HPS::EllipseKit::UnsetMajor ( )

Removes the intersection point of the major axis and the ellipse.

Returns: A reference to this EllipseKit.

◆ UnsetMinor()

EllipseKit& HPS::EllipseKit::UnsetMinor ( )

Removes the intersection point of the minor axis and the ellipse.

Returns: A reference to this EllipseKit.

◆ UnsetPriority()

EllipseKit& HPS::EllipseKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns: A reference to this object.

◆ UnsetUserData() [1/3]

EllipseKit& HPS::EllipseKit::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.

◆ UnsetUserData() [2/3]

EllipseKit& HPS::EllipseKit::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.

◆ UnsetUserData() [3/3]

EllipseKit& HPS::EllipseKit::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.

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

include/hps.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EllipseKit() [1/3]

◆ EllipseKit() [2/3]

◆ EllipseKit() [3/3]

Member Function Documentation

◆ Consume()

◆ Empty()

◆ Equals()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Set()

◆ SetCenter()

◆ SetMajor()

◆ SetMinor()

◆ SetPriority()

◆ SetUserData() [1/3]

◆ SetUserData() [2/3]

◆ SetUserData() [3/3]

◆ Show()

◆ ShowCenter()

◆ ShowMajor()

◆ ShowMinor()

◆ ShowPriority()

◆ ShowUserData() [1/2]

◆ ShowUserData() [2/2]

◆ ShowUserDataCount()

◆ ShowUserDataIndices()

◆ UnsetAllUserData()

◆ UnsetCenter()

◆ UnsetEverything()

◆ UnsetMajor()

◆ UnsetMinor()

◆ UnsetPriority()

◆ UnsetUserData() [1/3]

◆ UnsetUserData() [2/3]

◆ UnsetUserData() [3/3]