HPS::TouchState Class Reference

The TouchState class represents the state of touches on a multi-touch device for a particular event. More...

#include <hps.h>

Inheritance diagram for HPS::TouchState:

Collaboration diagram for HPS::TouchState:

Public Member Functions
	TouchState ()
	The default constructor creates an empty TouchState object. More...
	TouchState (TouchState const &in_that)
	The copy constructor creates a new TouchState object that contains the same settings as the source TouchState. More...
	TouchState (TouchState &&in_that)
	The move constructor creates a TouchState by transferring the underlying impl of the rvalue reference to this TouchState thereby avoiding a copy and allocation. More...
TouchState &	operator= (TouchState &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this TouchState thereby avoiding a copy. More...
	~TouchState ()
HPS::Type	ObjectType () const
void	Assign (TouchState const &in_that)
	Copies the source TouchState into this TouchState. More...
TouchState &	operator= (TouchState const &in_that)
	Copies the source TouchState into this TouchState. More...
bool	Equals (TouchState const &in_that) const
	Check if the source TouchState is equivalent to this TouchState. More...
bool	operator== (TouchState const &in_that) const
	Check if the source TouchState is equivalent to this TouchState. More...
bool	operator!= (TouchState const &in_that) const
	Check if the source TouchState is not equivalent to this TouchState. More...
void	Set (KeyArray const &in_path, TouchEvent const &in_event, TouchArray const &in_touches, ModifierKeys in_modifiers=ModifierKeys())
	Sets the properties of this TouchState. More...
HPS::TouchEvent	GetActiveEvent () const
	Get the active event for this TouchState. More...
HPS::WindowKey	GetEventSource () const
	Get the window which had focus when the touches represented by this TouchState underwent the active action. More...
HPS::KeyArray	GetEventPath () const
	Get the relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action. More...
size_t	GetTouchCount () const
	Get the number of touches currently down in this TouchState. More...
HPS::TouchArray	GetTouches () const
	Get the touches currently down in this TouchState. More...
ModifierKeys	GetModifierKeys () const
	Get an object representing the state of modifier keys for this TouchState. More...
void	SetActiveEvent (TouchEvent const &in_event)
	Sets the active event for this TouchState. More...
void	SetEventPath (KeyArray const &in_path)
	Sets the relevant list of keys up to the window which had focus for this touch event. More...
void	SetTouches (TouchArray const &in_touches)
	Sets the touches currently down in this TouchState. More...
void	SetModifierKeys (ModifierKeys in_modifiers)
	Sets an object representing the state of modifier keys for this TouchState. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. 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::TouchState

Detailed Description

The TouchState class represents the state of touches on a multi-touch device for a particular event.

Constructor & Destructor Documentation

TouchState() [1/3]

HPS::TouchState::TouchState

(

)

The default constructor creates an empty TouchState object.

TouchState() [2/3]

HPS::TouchState::TouchState

(

TouchState const &

in_that

)

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

Parameters

in_that

The source TouchState to copy.

TouchState() [3/3]

HPS::TouchState::TouchState

(

TouchState &&

in_that

)

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

Parameters

in_that

An rvalue reference to a TouchState to take the impl from.

~TouchState()

HPS::TouchState::~TouchState

(

)

Member Function Documentation

Assign()

void HPS::TouchState::Assign

(

TouchState const &

in_that

)

Copies the source TouchState into this TouchState.

Parameters

in_that

The source TouchState to copy.

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.

Empty()

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

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

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

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

Equals()

bool HPS::TouchState::Equals

(

TouchState const &

in_that

)

const

Check if the source TouchState is equivalent to this TouchState.

Parameters

in_kit

The source TouchState to compare to this TouchState.

Returns

true if the objects are equivalent, false otherwise.

GetActiveEvent()

HPS::TouchEvent HPS::TouchState::GetActiveEvent

(

)

const

Get the active event for this TouchState.

This will throw an exception if there is no active action for this TouchState.

Returns

The action for the active touches for this TouchState.

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.

GetEventPath()

HPS::KeyArray HPS::TouchState::GetEventPath

(

)

const

Get the relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action.

This will throw an exception if there is no event path for this TouchState.

Returns

The relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action.

GetEventSource()

HPS::WindowKey HPS::TouchState::GetEventSource

(

)

const

Get the window which had focus when the touches represented by this TouchState underwent the active action.

This will throw an exception if there is no event source for this TouchState.

Returns

The window which had focus when the touches represented by this TouchState underwent the active action.

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.

GetModifierKeys()

ModifierKeys HPS::TouchState::GetModifierKeys

(

)

const

Get an object representing the state of modifier keys for this TouchState.

Returns

An object representing the state of modifier keys.

GetTouchCount()

size_t HPS::TouchState::GetTouchCount

(

)

const

Get the number of touches currently down in this TouchState.

Returns

Number of touches.

GetTouches()

HPS::TouchArray HPS::TouchState::GetTouches

(

)

const

Get the touches currently down in this TouchState.

Returns

The list of touches.

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

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::TouchState::operator!=

(

TouchState const &

in_that

)

const

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

Parameters

in_kit

The source TouchState to compare to this TouchState.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

TouchState& HPS::TouchState::operator=

(

TouchState &&

in_that

)

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

Parameters

in_that

An rvalue reference to a TouchState to take the impl from.

Returns

A reference to this TouchState.

operator=() [2/2]

TouchState& HPS::TouchState::operator=

(

TouchState const &

in_that

)

Copies the source TouchState into this TouchState.

Parameters

in_that

The source TouchState to copy.

Returns

A reference to this TouchState.

operator==()

bool HPS::TouchState::operator==

(

TouchState const &

in_that

)

const

Check if the source TouchState is equivalent to this TouchState.

Parameters

in_kit

The source TouchState to compare to this TouchState.

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::TouchState::Set	(	KeyArray const &	in_path,
		TouchEvent const &	in_event,
		TouchArray const &	in_touches,
		ModifierKeys	in_modifiers = ModifierKeys()
	)

Sets the properties of this TouchState.

Parameters

in_path	The list of keys up to the window which had focus for this touch event.
in_event	The touch event.
in_touches	The touches down during this touch event.
in_modifiers	The state of modifier keys for this touch event.

SetActiveEvent()

void HPS::TouchState::SetActiveEvent

(

TouchEvent const &

in_event

)

Sets the active event for this TouchState.

Parameters

in_event

The action for this TouchState.

SetEventPath()

void HPS::TouchState::SetEventPath

(

KeyArray const &

in_path

)

Sets the relevant list of keys up to the window which had focus for this touch event.

Parameters

in_path

The relevant list of keys up to the window which had focus when the touches represented by this TouchState underwent the active action.

SetModifierKeys()

void HPS::TouchState::SetModifierKeys

(

ModifierKeys

in_modifiers

)

Sets an object representing the state of modifier keys for this TouchState.

Parameters

in_modifiers

An object representing the state of modifier keys.

SetTouches()

void HPS::TouchState::SetTouches

(

TouchArray const &

in_touches

)

Sets the touches currently down in this TouchState.

Parameters

in_touches

The list of touches.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

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 in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::TouchState::staticType = HPS::Type::TouchState

static

---

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

• hps.h