Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::InfiniteLineKit Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::InfiniteLineKit:
Collaboration diagram for HPS::InfiniteLineKit:

Public Member Functions

 InfiniteLineKit ()
 The default constructor creates an empty InfiniteLineKit object. More...
 
 InfiniteLineKit (InfiniteLineKit const &in_kit)
 The copy constructor creates a new InfiniteLineKit object that contains the same settings as the source InfiniteLineKit. More...
 
 InfiniteLineKit (InfiniteLineKit &&in_that)
 The move constructor creates an InfiniteLineKit by transferring the underlying impl of the rvalue reference to this InfiniteLineKit thereby avoiding a copy and allocation. More...
 
InfiniteLineKitoperator= (InfiniteLineKit &&in_that)
 The move assignment operator transfers the underlying impl of the rvalue reference to this InfiniteLineKit thereby avoiding a copy. More...
 
virtual ~InfiniteLineKit ()
 
HPS::Type ObjectType () const
 
void Consume (InfiniteLineKit &in_kit)
 Copies the source InfiniteLineKit into this InfiniteLineKit and resets the source kit. More...
 
void Set (InfiniteLineKit const &in_kit)
 Copies the source InfiniteLineKit into this InfiniteLineKit. More...
 
void Show (InfiniteLineKit &out_kit) const
 Copies this InfiniteLineKit into the given InfiniteLineKit. More...
 
InfiniteLineKitoperator= (InfiniteLineKit const &in_kit)
 Copies the source InfiniteLineKit into this InfiniteLineKit. More...
 
bool Empty () const
 Indicates whether this InfiniteLineKit has any values set on it. More...
 
bool Equals (InfiniteLineKit const &in_kit) const
 Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit. More...
 
bool operator== (InfiniteLineKit const &in_kit) const
 Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit. More...
 
bool operator!= (InfiniteLineKit const &in_kit) const
 Check if the source InfiniteLineKit is not equivalent to this InfiniteLineKit. More...
 
InfiniteLineKitSetPriority (int in_priority)
 Assigns a specific drawing priority value to the InfiniteLineKit. More...
 
InfiniteLineKitUnsetPriority ()
 Removes a drawing priority setting. More...
 
bool ShowPriority (int &out_priority) const
 Shows the drawing priority. More...
 
InfiniteLineKitSetFirst (Point const &in_first)
 Sets the first point for this InfiniteLineKit. More...
 
InfiniteLineKitSetSecond (Point const &in_second)
 Sets the second point for this InfiniteLineKit. More...
 
InfiniteLineKitSetType (InfiniteLine::Type in_type)
 Sets the type of this InfiniteLineKit. More...
 
InfiniteLineKitUnsetFirst ()
 Removes the first point for this InfiniteLineKit. More...
 
InfiniteLineKitUnsetSecond ()
 Removes the second point for this InfiniteLineKit. More...
 
InfiniteLineKitUnsetType ()
 Removes the type of this InfiniteLineKit. More...
 
InfiniteLineKitUnsetEverything ()
 Removes all settings from the InfiniteLineKit. More...
 
bool ShowFirst (Point &out_first) const
 Shows the first point for this InfiniteLineKit. More...
 
bool ShowSecond (Point &out_second) const
 Shows the second point for this InfiniteLineKit. More...
 
bool ShowType (InfiniteLine::Type &out_type) const
 Shows the type of this InfiniteLineKit. More...
 
InfiniteLineKitSetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 Sets user data on this kit. More...
 
InfiniteLineKitSetUserData (intptr_t in_index, ByteArray const &in_data)
 Sets user data on this kit. More...
 
InfiniteLineKitSetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 Sets user data on this kit. More...
 
InfiniteLineKitUnsetUserData (intptr_t in_index)
 Removes the user data at the given index from this kit. More...
 
InfiniteLineKitUnsetUserData (size_t in_count, intptr_t const in_indices[])
 Removes the user data at the given indices from this kit. More...
 
InfiniteLineKitUnsetUserData (IntPtrTArray const &in_indices)
 Removes the user data at the given indices from this kit. More...
 
InfiniteLineKitUnsetAllUserData ()
 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::InfiniteLineKit
 

Detailed Description

The InfiniteLineKit class is a user space object.

It is a kit analog to an InfiniteLineKey.

Constructor & Destructor Documentation

◆ InfiniteLineKit() [1/3]

HPS::InfiniteLineKit::InfiniteLineKit ( )

The default constructor creates an empty InfiniteLineKit object.

◆ InfiniteLineKit() [2/3]

HPS::InfiniteLineKit::InfiniteLineKit ( InfiniteLineKit const &  in_kit)

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

Parameters
in_kitThe source InfiniteLineKit to copy.

◆ InfiniteLineKit() [3/3]

HPS::InfiniteLineKit::InfiniteLineKit ( InfiniteLineKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an InfiniteLineKit to take the impl from.

◆ ~InfiniteLineKit()

virtual HPS::InfiniteLineKit::~InfiniteLineKit ( )
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::InfiniteLineKit::Consume ( InfiniteLineKit in_kit)

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

Parameters
in_kitThe source InfiniteLineKit to consume.

◆ Empty()

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

Indicates whether this InfiniteLineKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit.

Parameters
in_kitThe source InfiniteLineKit to compare to this InfiniteLineKit.
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_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::InfiniteLineKit::ObjectType ( ) const
inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

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

◆ operator=() [1/2]

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

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

Parameters
in_thatAn rvalue reference to an InfiniteLineKit to take the impl from.
Returns
A reference to this InfiniteLineKit.

◆ operator=() [2/2]

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

Copies the source InfiniteLineKit into this InfiniteLineKit.

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

◆ operator==()

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

Check if the source InfiniteLineKit is equivalent to this InfiniteLineKit.

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

◆ Reset()

◆ Set()

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

Copies the source InfiniteLineKit into this InfiniteLineKit.

Parameters
in_kitThe source InfiniteLineKit to copy.

◆ SetFirst()

InfiniteLineKit& HPS::InfiniteLineKit::SetFirst ( Point const &  in_first)

Sets the first point for this InfiniteLineKit.

Parameters
in_firstThe first point for this InfiniteLineKit. If the type is InfiniteLine::Type::Ray, this will be the point at which the ray starts.
Returns
A reference to this InfiniteLineKit.

◆ SetPriority()

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

Assigns a specific drawing priority value to the InfiniteLineKit.

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

◆ SetSecond()

InfiniteLineKit& HPS::InfiniteLineKit::SetSecond ( Point const &  in_second)

Sets the second point for this InfiniteLineKit.

Parameters
in_secondThe second point for this InfiniteLineKit. If the type is InfiniteLine::Type::Ray, this will be the point through which the ray passes.
Returns
A reference to this InfiniteLineKit.

◆ SetType()

InfiniteLineKit& HPS::InfiniteLineKit::SetType ( InfiniteLine::Type  in_type)

Sets the type of this InfiniteLineKit.

Parameters
in_typeThe type of this InfiniteLineKit.
Returns
A reference to this InfiniteLineKit.

◆ SetUserData() [1/3]

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

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

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

Copies this InfiniteLineKit into the given InfiniteLineKit.

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

◆ ShowFirst()

bool HPS::InfiniteLineKit::ShowFirst ( Point out_first) const

Shows the first point for this InfiniteLineKit.

Parameters
out_firstThe first point for this InfiniteLineKit.
Returns
true if a first point was set, false otherwise.

◆ ShowPriority()

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

◆ ShowSecond()

bool HPS::InfiniteLineKit::ShowSecond ( Point out_second) const

Shows the second point for this InfiniteLineKit.

Parameters
out_secondThe second point for this InfiniteLineKit.
Returns
true if a second point was set, false otherwise.

◆ ShowType()

bool HPS::InfiniteLineKit::ShowType ( InfiniteLine::Type out_type) const

Shows the type of this InfiniteLineKit.

Parameters
out_typeThe type of this InfiniteLineKit.
Returns
true if a type was set, false otherwise.

◆ ShowUserData() [1/2]

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

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

◆ ShowUserDataIndices()

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

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

InfiniteLineKit& HPS::InfiniteLineKit::UnsetAllUserData ( )

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetEverything()

InfiniteLineKit& HPS::InfiniteLineKit::UnsetEverything ( )

Removes all settings from the InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetFirst()

InfiniteLineKit& HPS::InfiniteLineKit::UnsetFirst ( )

Removes the first point for this InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetPriority()

InfiniteLineKit& HPS::InfiniteLineKit::UnsetPriority ( )

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetSecond()

InfiniteLineKit& HPS::InfiniteLineKit::UnsetSecond ( )

Removes the second point for this InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetType()

InfiniteLineKit& HPS::InfiniteLineKit::UnsetType ( )

Removes the type of this InfiniteLineKit.

Returns
A reference to this InfiniteLineKit.

◆ UnsetUserData() [1/3]

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

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

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::InfiniteLineKit::staticType = HPS::Type::InfiniteLineKit
static

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