#include <hps.h>

Inheritance diagram for HPS::CircleKit:
HPS::Kit HPS::Object

Public Member Functions

 CircleKit ()
 
 CircleKit (CircleKit const &in_kit)
 
 CircleKit (CircleKit &&in_that)
 
void Consume (CircleKit &in_kit)
 
bool Empty () const
 
bool Equals (CircleKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (CircleKit const &in_kit) const
 
CircleKitoperator= (CircleKit &&in_that)
 
CircleKitoperator= (CircleKit const &in_kit)
 
bool operator== (CircleKit const &in_kit) const
 
void Set (CircleKit const &in_kit)
 
CircleKitSetCenter (Point const &in_center)
 
CircleKitSetNormal (Vector const &in_normal)
 
CircleKitSetPriority (int const in_priority)
 
CircleKitSetRadius (float in_radius)
 
CircleKitSetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
CircleKitSetUserData (intptr_t in_index, ByteArray const &in_data)
 
CircleKitSetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
void Show (CircleKit &out_kit) const
 
bool ShowCenter (Point &out_center) const
 
bool ShowNormal (Vector &out_normal) const
 
bool ShowPriority (int &out_priority) const
 
bool ShowRadius (float &out_radius) 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
 
CircleKitUnsetAllUserData ()
 
CircleKitUnsetCenter ()
 
CircleKitUnsetEverything ()
 
CircleKitUnsetNormal ()
 
CircleKitUnsetPriority ()
 
CircleKitUnsetRadius ()
 
CircleKitUnsetUserData (intptr_t in_index)
 
CircleKitUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
CircleKitUnsetUserData (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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::CircleKit
 
- 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)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CircleKit() [1/3]

HPS::CircleKit::CircleKit ( )

The default constructor creates an empty CircleKit object.

◆ CircleKit() [2/3]

HPS::CircleKit::CircleKit ( CircleKit const &  in_kit)

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

Parameters
in_kitThe source CircleKit to copy.

◆ CircleKit() [3/3]

HPS::CircleKit::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_thatAn rvalue reference to a CircleKit to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::CircleKit::Consume ( CircleKit in_kit)

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

Parameters
in_kitThe source CircleKit to consume.

◆ Empty()

bool HPS::CircleKit::Empty ( ) const
virtual

Indicates whether this CircleKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source CircleKit is equivalent to this CircleKit.

Parameters
in_kitThe source CircleKit to compare to this CircleKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

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

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

Parameters
in_kitThe source CircleKit to compare to this CircleKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

CircleKit& HPS::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_thatAn rvalue reference to a CircleKit to take the impl from.
Returns
A reference to this CircleKit.

◆ operator=() [2/2]

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

Copies the source CircleKit into this CircleKit.

Parameters
in_kitThe source CircleKit to copy.
Returns
A reference to this CircleKit.

◆ operator==()

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

Check if the source CircleKit is equivalent to this CircleKit.

Parameters
in_kitThe source CircleKit to compare to this CircleKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies the source CircleKit into this CircleKit.

Parameters
in_kitThe source CircleKit to copy.

◆ SetCenter()

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

Sets the center point for this CircleKit.

Parameters
in_centerThe center point for this CircleKit.
Returns
A reference to this CircleKit.

◆ SetNormal()

CircleKit& HPS::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_normalThe normal for this CircleKit.
Returns
A reference to this CircleKit.

◆ SetPriority()

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

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

CircleKit& HPS::CircleKit::SetRadius ( float  in_radius)

Sets the radius for this CircleKit.

Parameters
in_radiusThe radius for this CircleKit.
Returns
A reference to this CircleKit.

◆ SetUserData() [1/3]

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

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

CircleKit& HPS::CircleKit::SetUserData ( intptr_t  in_index,
ByteArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

CircleKit& HPS::CircleKit::SetUserData ( IntPtrTArray const &  in_indices,
ByteArrayArray const &  in_data 
)

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ Show()

void HPS::CircleKit::Show ( CircleKit out_kit) const

Copies this CircleKit into the given CircleKit.

Parameters
out_kitThe CircleKit to populate with the contents of this CircleKit.

◆ ShowCenter()

bool HPS::CircleKit::ShowCenter ( Point out_center) const

Shows the center point for this CircleKit.

Parameters
out_centerThe center point for this CircleKit.
Returns
true if a center point was set, false otherwise.

◆ ShowNormal()

bool HPS::CircleKit::ShowNormal ( Vector out_normal) const

Shows the normal for this CircleKit.

Parameters
out_normalThe normal for this CircleKit.
Returns
true if a normal was set, false otherwise.

◆ ShowPriority()

bool HPS::CircleKit::ShowPriority ( int &  out_priority) const

Shows the drawing priority.

Parameters
out_priorityThe 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::CircleKit::ShowRadius ( float &  out_radius) const

Shows the radius for this CircleKit.

Parameters
out_radiusThe radius for this CircleKit.
Returns
true if a radius was set, false otherwise.

◆ ShowUserData() [1/2]

bool HPS::CircleKit::ShowUserData ( intptr_t  in_index,
ByteArray out_data 
) const

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

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS::CircleKit::ShowUserData ( IntPtrTArray out_indices,
ByteArrayArray out_data 
) const

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn 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::CircleKit::ShowUserDataCount ( ) const

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

◆ ShowUserDataIndices()

bool HPS::CircleKit::ShowUserDataIndices ( IntPtrTArray out_indices) const

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

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ UnsetAllUserData()

CircleKit& HPS::CircleKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetCenter()

CircleKit& HPS::CircleKit::UnsetCenter ( )

Removes the center point for this CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetEverything()

CircleKit& HPS::CircleKit::UnsetEverything ( )

Removes all settings from the CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetNormal()

CircleKit& HPS::CircleKit::UnsetNormal ( )

Removes the normal for this CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetPriority()

CircleKit& HPS::CircleKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetRadius()

CircleKit& HPS::CircleKit::UnsetRadius ( )

Removes the radius for this CircleKit.

Returns
A reference to this CircleKit.

◆ UnsetUserData() [1/3]

CircleKit& HPS::CircleKit::UnsetUserData ( intptr_t  in_index)

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

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/3]

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

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

Parameters
in_countThe size of the following array.
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [3/3]

CircleKit& HPS::CircleKit::UnsetUserData ( IntPtrTArray const &  in_indices)

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

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

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