The SphereKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::SphereKit:

Collaboration diagram for HPS::SphereKit:

Public Member Functions
	SphereKit ()
	The default constructor creates an empty SphereKit object. More...

	SphereKit (SphereKit const &in_kit)
	The copy constructor creates a new SphereKit object that contains the same settings as the source SphereKit. More...

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

SphereKit &	operator= (SphereKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this SphereKit thereby avoiding a copy. More...

virtual	~SphereKit ()

HPS::Type	ObjectType () const

void	Consume (SphereKit &in_kit)
	Copies the source SphereKit into this SphereKit and resets the source kit. More...

void	Set (SphereKit const &in_kit)
	Copies the source SphereKit into this SphereKit. More...

void	Show (SphereKit &out_kit) const
	Copies this SphereKit into the given SphereKit. More...

SphereKit &	operator= (SphereKit const &in_kit)
	Copies the source SphereKit into this SphereKit. More...

bool	Empty () const
	Indicates whether this SphereKit has any values set on it. More...

bool	Equals (SphereKit const &in_kit) const
	Check if the source SphereKit is equivalent to this SphereKit. More...

bool	operator== (SphereKit const &in_kit) const
	Check if the source SphereKit is equivalent to this SphereKit. More...

bool	operator!= (SphereKit const &in_kit) const
	Check if the source SphereKit is not equivalent to this SphereKit. More...

SphereKit &	SetPriority (int in_priority)
	Assigns a specific drawing priority value to the SphereKit. More...

SphereKit &	UnsetPriority ()
	Removes a drawing priority setting. More...

bool	ShowPriority (int &out_priority) const
	Shows the drawing priority. More...

SphereKit &	SetCenter (Point const &in_center)
	Sets the center point for the SphereKit. More...

SphereKit &	SetRadius (float in_radius)
	Sets the radius for the SphereKit. More...

SphereKit &	SetBasis (Vector const &in_vertical, Vector const &in_horizontal)
	Sets the basis for the SphereKit. More...

SphereKit &	UnsetCenter ()
	Removes the center point for this SphereKit. More...

SphereKit &	UnsetRadius ()
	Removes the radius for this SphereKit. More...

SphereKit &	UnsetBasis ()
	Removes the basis for this SphereKit. More...

SphereKit &	UnsetEverything ()
	Removes all settings from the SphereKit. More...

bool	ShowCenter (Point &out_center) const
	Shows the center point for this SphereKit. More...

bool	ShowRadius (float &out_radius) const
	Shows the radius for the SphereKit. More...

bool	ShowBasis (Vector &out_vertical, Vector &out_horizontal) const
	Shows the basis for the SphereKit. More...

SphereKit &	SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
	Sets user data on this kit. More...

SphereKit &	SetUserData (intptr_t in_index, ByteArray const &in_data)
	Sets user data on this kit. More...

SphereKit &	SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
	Sets user data on this kit. More...

SphereKit &	UnsetUserData (intptr_t in_index)
	Removes the user data at the given index from this kit. More...

SphereKit &	UnsetUserData (size_t in_count, intptr_t const in_indices[])
	Removes the user data at the given indices from this kit. More...

SphereKit &	UnsetUserData (IntPtrTArray const &in_indices)
	Removes the user data at the given indices from this kit. More...

SphereKit &	UnsetAllUserData ()
	Removes all user data from this kit. More...

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

bool	ShowUserDataIndices (IntPtrTArray &out_indices) const
	Shows the indices of all user data set on this kit. More...

bool	ShowUserData (intptr_t in_index, ByteArray &out_data) const
	Shows the user data at a given index for this kit. More...

bool	ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
	Shows all user data for this kit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Detailed Description

The SphereKit class is a user space object.

It is a kit analog to a SphereKey.

Constructor & Destructor Documentation

◆ SphereKit() [1/3]

HPS::SphereKit::SphereKit ( )

The default constructor creates an empty SphereKit object.

◆ SphereKit() [2/3]

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

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

virtual HPS::SphereKit::~SphereKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Consume()

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

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

Parameters

in_kit The source SphereKit to consume.

◆ Empty()

bool HPS::SphereKit::Empty ( ) const

virtual

Indicates whether this SphereKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::SphereKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ operator==()

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

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source SphereKit into this SphereKit.

Parameters

in_kit The source SphereKit to copy.

◆ SetBasis()

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

◆ SetCenter()

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

◆ SetPriority()

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

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()

◆ SetRadius()

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

◆ SetUserData() [1/3]

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

◆ SetUserData() [2/3]

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

◆ SetUserData() [3/3]

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

◆ Show()

void HPS::SphereKit::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.

◆ ShowBasis()

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

◆ ShowCenter()

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

◆ ShowPriority()

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

◆ ShowRadius()

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

◆ ShowUserData() [1/2]

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

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

◆ ShowUserDataIndices()

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

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetAllUserData()

SphereKit& HPS::SphereKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns: A reference to this kit.

◆ UnsetBasis()

SphereKit& HPS::SphereKit::UnsetBasis ( )

Removes the basis for this SphereKit.

Returns: A reference to this SphereKit.

◆ UnsetCenter()

SphereKit& HPS::SphereKit::UnsetCenter ( )

Removes the center point for this SphereKit.

Returns: A reference to this SphereKit.

◆ UnsetEverything()

SphereKit& HPS::SphereKit::UnsetEverything ( )

Removes all settings from the SphereKit.

Returns: A reference to this SphereKit.

◆ UnsetPriority()

SphereKit& HPS::SphereKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns: A reference to this object.

◆ UnsetRadius()

SphereKit& HPS::SphereKit::UnsetRadius ( )

Removes the radius for this SphereKit.

Returns: A reference to this SphereKit.

◆ UnsetUserData() [1/3]

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

◆ UnsetUserData() [2/3]

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

◆ UnsetUserData() [3/3]

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::SphereKit::staticType = HPS::Type::SphereKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SphereKit() [1/3]

◆ SphereKit() [2/3]

◆ SphereKit() [3/3]

◆ ~SphereKit()

Member Function Documentation

◆ ClassID()

◆ Consume()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetBasis()

◆ SetCenter()

◆ SetPriority()

◆ SetRadius()

◆ SetUserData() [1/3]

◆ SetUserData() [2/3]

◆ SetUserData() [3/3]

◆ Show()

◆ ShowBasis()

◆ ShowCenter()

◆ ShowPriority()

◆ ShowRadius()

◆ ShowUserData() [1/2]

◆ ShowUserData() [2/2]

◆ ShowUserDataCount()

◆ ShowUserDataIndices()

◆ Type()

◆ UnsetAllUserData()

◆ UnsetBasis()

◆ UnsetCenter()

◆ UnsetEverything()

◆ UnsetPriority()

◆ UnsetRadius()

◆ UnsetUserData() [1/3]

◆ UnsetUserData() [2/3]

◆ UnsetUserData() [3/3]

Member Data Documentation

◆ staticType