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

#include <hps.h>

Inheritance diagram for HPS::CircularWedgeKit:

Collaboration diagram for HPS::CircularWedgeKit:

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

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

	CircularWedgeKit (CircularWedgeKit &&in_that)
	The move constructor creates a CircularWedgeKit by transferring the underlying impl of the rvalue reference to this CircularWedgeKit thereby avoiding a copy and allocation. More...

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

virtual	~CircularWedgeKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

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

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

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

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

CircularWedgeKit &	SetStart (Point const &in_start)
	Sets the start point for this CircularWedgeKit. More...

CircularWedgeKit &	SetMiddle (Point const &in_middle)
	Sets the middle point for this CircularWedgeKit. More...

CircularWedgeKit &	SetEnd (Point const &in_end)
	Sets the end point for this CircularWedgeKit. More...

CircularWedgeKit &	UnsetStart ()
	Removes the start point for this CircularWedgeKit. More...

CircularWedgeKit &	UnsetMiddle ()
	Removes the middle point for this CircularWedgeKit. More...

CircularWedgeKit &	UnsetEnd ()
	Removes the end point for this CircularWedgeKit. More...

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

bool	ShowStart (Point &out_start) const
	Shows the start point for this CircularWedgeKit. More...

bool	ShowMiddle (Point &out_middle) const
	Shows the middle point for this CircularWedgeKit. More...

bool	ShowEnd (Point &out_end) const
	Shows the end point for this CircularWedgeKit. More...

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

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

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

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

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

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

CircularWedgeKit &	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::CircularWedgeKit

Detailed Description

The CircularWedgeKit class is a user space object.

It is a kit analog to a CircularWedgeKey.

Constructor & Destructor Documentation

◆ CircularWedgeKit() [1/3]

HPS::CircularWedgeKit::CircularWedgeKit ( )

The default constructor creates an empty CircularWedgeKit object.

◆ CircularWedgeKit() [2/3]

HPS::CircularWedgeKit::CircularWedgeKit ( CircularWedgeKit const & in_kit )

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

Parameters

in_kit The source CircularWedgeKit to copy.

◆ CircularWedgeKit() [3/3]

HPS::CircularWedgeKit::CircularWedgeKit ( CircularWedgeKit && in_that )

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

Parameters

in_that An rvalue reference to a CircularWedgeKit to take the impl from.

◆ ~CircularWedgeKit()

virtual HPS::CircularWedgeKit::~CircularWedgeKit ( )

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::CircularWedgeKit::Consume ( CircularWedgeKit & in_kit )

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

Parameters

in_kit The source CircularWedgeKit to consume.

◆ Empty()

bool HPS::CircularWedgeKit::Empty ( ) const

virtual

Indicates whether this CircularWedgeKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit.

Parameters

in_kit The source CircularWedgeKit to compare to this CircularWedgeKit.

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::CircularWedgeKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::CircularWedgeKit::operator!= ( CircularWedgeKit const & in_kit ) const

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

Parameters

in_kit The source CircularWedgeKit to compare to this CircularWedgeKit.

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

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a CircularWedgeKit to take the impl from.

Returns: A reference to this CircularWedgeKit.

◆ operator=() [2/2]

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

Copies the source CircularWedgeKit into this CircularWedgeKit.

Parameters

in_kit The source CircularWedgeKit to copy.

Returns: A reference to this CircularWedgeKit.

◆ operator==()

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

Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit.

Parameters

in_kit The source CircularWedgeKit to compare to this CircularWedgeKit.

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::CircularWedgeKit::Set ( CircularWedgeKit const & in_kit )

Copies the source CircularWedgeKit into this CircularWedgeKit.

Parameters

in_kit The source CircularWedgeKit to copy.

◆ SetEnd()

CircularWedgeKit& HPS::CircularWedgeKit::SetEnd ( Point const & in_end )

Sets the end point for this CircularWedgeKit.

This is the point on the circumference of the circle at which the circular wedge ends.

Parameters

in_end The end point for this CircularWedgeKit.

Returns: A reference to this CircularWedgeKit.

◆ SetMiddle()

CircularWedgeKit& HPS::CircularWedgeKit::SetMiddle ( Point const & in_middle )

Sets the middle point for this CircularWedgeKit.

This is a point on the circumference of the circle between the start and end points for the circular wedge.

Parameters

in_middle The middle point for this CircularWedgeKit.

Returns: A reference to this CircularWedgeKit.

◆ SetPriority()

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

Assigns a specific drawing priority value to the CircularWedgeKit.

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

◆ SetStart()

CircularWedgeKit& HPS::CircularWedgeKit::SetStart ( Point const & in_start )

Sets the start point for this CircularWedgeKit.

This is the point on the circumference of the circle at which the circular wedge starts.

Parameters

in_start The start point for this CircularWedgeKit.

Returns: A reference to this CircularWedgeKit.

◆ SetUserData() [1/3]

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

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

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

Copies this CircularWedgeKit into the given CircularWedgeKit.

Parameters

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

◆ ShowEnd()

bool HPS::CircularWedgeKit::ShowEnd ( Point & out_end ) const

Shows the end point for this CircularWedgeKit.

Parameters

out_end The end point for this CircularWedgeKit.

Returns: true if an end point was set, false otherwise.

◆ ShowMiddle()

bool HPS::CircularWedgeKit::ShowMiddle ( Point & out_middle ) const

Shows the middle point for this CircularWedgeKit.

Parameters

out_middle The middle point for this CircularWedgeKit.

Returns: true if a middle point was set, false otherwise.

◆ ShowPriority()

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

◆ ShowStart()

bool HPS::CircularWedgeKit::ShowStart ( Point & out_start ) const

Shows the start point for this CircularWedgeKit.

Parameters

out_start The start point for this CircularWedgeKit.

Returns: true if a start point was set, false otherwise.

◆ ShowUserData() [1/2]

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

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

◆ ShowUserDataIndices()

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

CircularWedgeKit& HPS::CircularWedgeKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns: A reference to this kit.

◆ UnsetEnd()

CircularWedgeKit& HPS::CircularWedgeKit::UnsetEnd ( )

Removes the end point for this CircularWedgeKit.

Returns: A reference to this CircularWedgeKit.

◆ UnsetEverything()

CircularWedgeKit& HPS::CircularWedgeKit::UnsetEverything ( )

Removes all settings from the CircularWedgeKit.

Returns: A reference to this CircularWedgeKit.

◆ UnsetMiddle()

CircularWedgeKit& HPS::CircularWedgeKit::UnsetMiddle ( )

Removes the middle point for this CircularWedgeKit.

Returns: A reference to this CircularWedgeKit.

◆ UnsetPriority()

CircularWedgeKit& HPS::CircularWedgeKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns: A reference to this object.

◆ UnsetStart()

CircularWedgeKit& HPS::CircularWedgeKit::UnsetStart ( )

Removes the start point for this CircularWedgeKit.

Returns: A reference to this CircularWedgeKit.

◆ UnsetUserData() [1/3]

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

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

CircularWedgeKit& HPS::CircularWedgeKit::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::CircularWedgeKit::staticType = HPS::Type::CircularWedgeKit

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

◆ CircularWedgeKit() [1/3]

◆ CircularWedgeKit() [2/3]

◆ CircularWedgeKit() [3/3]

◆ ~CircularWedgeKit()

Member Function Documentation

◆ ClassID()

◆ Consume()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetEnd()

◆ SetMiddle()

◆ SetPriority()

◆ SetStart()

◆ SetUserData() [1/3]

◆ SetUserData() [2/3]

◆ SetUserData() [3/3]

◆ Show()

◆ ShowEnd()

◆ ShowMiddle()

◆ ShowPriority()

◆ ShowStart()

◆ ShowUserData() [1/2]

◆ ShowUserData() [2/2]

◆ ShowUserDataCount()

◆ ShowUserDataIndices()

◆ Type()

◆ UnsetAllUserData()

◆ UnsetEnd()

◆ UnsetEverything()

◆ UnsetMiddle()

◆ UnsetPriority()

◆ UnsetStart()

◆ UnsetUserData() [1/3]

◆ UnsetUserData() [2/3]

◆ UnsetUserData() [3/3]

Member Data Documentation

◆ staticType