HPS::KeyboardState Class Reference

The KeyboardState class represents the state of a keyboard for a particular event. More...

#include <hps.h>

Inheritance diagram for HPS::KeyboardState:

Collaboration diagram for HPS::KeyboardState:

Public Member Functions
	KeyboardState ()
	The default constructor creates an empty KeyboardState object. More...
	KeyboardState (KeyboardState const &in_that)
	The copy constructor creates a new KeyboardState object that contains the same settings as the source KeyboardState. More...
	KeyboardState (KeyboardState &&in_that)
	The move constructor creates a KeyboardState by transferring the underlying impl of the rvalue reference to this KeyboardState thereby avoiding a copy and allocation. More...
KeyboardState &	operator= (KeyboardState &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this KeyboardState thereby avoiding a copy. More...
	~KeyboardState ()
HPS::Type	ObjectType () const
void	Assign (KeyboardState const &in_that)
	Copies the source KeyboardState into this KeyboardState. More...
KeyboardState &	operator= (KeyboardState const &in_that)
	Copies the source KeyboardState into this KeyboardState. More...
bool	Equals (KeyboardState const &in_that) const
	Check if the source KeyboardState is equivalent to this KeyboardState. More...
bool	operator== (KeyboardState const &in_that) const
	Check if the source KeyboardState is equivalent to this KeyboardState. More...
bool	operator!= (KeyboardState const &in_that) const
	Check if the source KeyboardState is not equivalent to this KeyboardState. More...
void	Set (KeyArray const &in_path, KeyboardEvent const &in_event, KeyboardCodeArray const &in_keyboard_codes, ModifierKeys in_modifiers=ModifierKeys())
	Sets the properties of this KeyboardState. More...
HPS::KeyboardEvent	GetActiveEvent () const
	Get the active event for this KeyboardState. More...
HPS::WindowKey	GetEventSource () const
	Get the window which had focus when the keys represented by this KeyboardState were pressed or released. More...
HPS::KeyArray	GetEventPath () const
	Get the relevant list of keys up to the window which had focus when the keys represented by this KeyboardState were pressed or released. More...
size_t	GetKeyboardCodeCount () const
	Get the number of keys currently down in this KeyboardState. More...
HPS::KeyboardCodeArray	GetKeyboardCodes () const
	Get the list of keyboard codes for keys currently down in this KeyboardState. More...
bool	GetKeyState (HPS::KeyboardCode in_key_code) const
	Get the state of a specific keyboard code for this KeyboardState. More...
ModifierKeys	GetModifierKeys () const
	Get an object representing the state of modifier keys for this KeyboardState. More...
void	SetActiveEvent (KeyboardEvent const &in_event)
	Sets the active event for this KeyboardState. More...
void	SetEventPath (KeyArray const &in_path)
	Sets the relevant list of keys up to the window which had focus for this keyboard event. More...
void	SetKeyboardCodes (KeyboardCodeArray const &in_keyboard_codes)
	Sets the list of keyboard codes for keys currently down in this KeyboardState. More...
void	SetModifierKeys (ModifierKeys in_modifiers)
	Sets an object representing the state of modifier keys for this KeyboardState. 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::KeyboardState

Detailed Description

The KeyboardState class represents the state of a keyboard for a particular event.

Constructor & Destructor Documentation

KeyboardState() [1/3]

HPS::KeyboardState::KeyboardState

(

)

The default constructor creates an empty KeyboardState object.

KeyboardState() [2/3]

HPS::KeyboardState::KeyboardState

(

KeyboardState const &

in_that

)

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

Parameters

in_that

The source KeyboardState to copy.

KeyboardState() [3/3]

HPS::KeyboardState::KeyboardState

(

KeyboardState &&

in_that

)

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

Parameters

in_that

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

~KeyboardState()

HPS::KeyboardState::~KeyboardState

(

)

Member Function Documentation

Assign()

void HPS::KeyboardState::Assign

(

KeyboardState const &

in_that

)

Copies the source KeyboardState into this KeyboardState.

Parameters

in_that

The source KeyboardState 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::KeyboardState::Equals

(

KeyboardState const &

in_that

)

const

Check if the source KeyboardState is equivalent to this KeyboardState.

Parameters

in_that

The source KeyboardState to compare to this KeyboardState.

Returns

true if the objects are equivalent, false otherwise.

GetActiveEvent()

HPS::KeyboardEvent HPS::KeyboardState::GetActiveEvent

(

)

const

Get the active event for this KeyboardState.

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

Returns

The action for the active keyboard codes for this KeyboardState.

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::KeyboardState::GetEventPath

(

)

const

Get the relevant list of keys up to the window which had focus when the keys represented by this KeyboardState were pressed or released.

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

Returns

The relevant list of keys up to the window which had focus when the keys represented by this KeyboardState were pressed or released.

GetEventSource()

HPS::WindowKey HPS::KeyboardState::GetEventSource

(

)

const

Get the window which had focus when the keys represented by this KeyboardState were pressed or released.

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

Returns

The window which had focus when the keys represented by this KeyboardState were pressed or released.

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.

GetKeyboardCodeCount()

size_t HPS::KeyboardState::GetKeyboardCodeCount

(

)

const

Get the number of keys currently down in this KeyboardState.

Returns

Number of active and inactive keyboard codes.

GetKeyboardCodes()

HPS::KeyboardCodeArray HPS::KeyboardState::GetKeyboardCodes

(

)

const

Get the list of keyboard codes for keys currently down in this KeyboardState.

Returns

The list of active and inactive keyboard codes.

GetKeyState()

bool HPS::KeyboardState::GetKeyState

(

HPS::KeyboardCode

in_key_code

)

const

Get the state of a specific keyboard code for this KeyboardState.

Parameters

in_key_code

The keyboard code for which to query the action.

Returns

true if the key is down, false otherwise.

GetModifierKeys()

ModifierKeys HPS::KeyboardState::GetModifierKeys

(

)

const

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

Returns

An object representing the state of modifier keys.

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

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::KeyboardState::operator!=

(

KeyboardState const &

in_that

)

const

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

Parameters

in_that

The source KeyboardState to compare to this KeyboardState.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

KeyboardState& HPS::KeyboardState::operator=

(

KeyboardState &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this KeyboardState.

operator=() [2/2]

KeyboardState& HPS::KeyboardState::operator=

(

KeyboardState const &

in_that

)

Copies the source KeyboardState into this KeyboardState.

Parameters

in_that

The source KeyboardState to copy.

Returns

A reference to this KeyboardState.

operator==()

bool HPS::KeyboardState::operator==

(

KeyboardState const &

in_that

)

const

Check if the source KeyboardState is equivalent to this KeyboardState.

Parameters

in_that

The source KeyboardState to compare to this KeyboardState.

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::KeyboardState::Set	(	KeyArray const &	in_path,
		KeyboardEvent const &	in_event,
		KeyboardCodeArray const &	in_keyboard_codes,
		ModifierKeys	in_modifiers = ModifierKeys()
	)

Sets the properties of this KeyboardState.

Parameters

in_path	The list of keys up to the window which had focus for this keyboard event.
in_event	The keyboard event.
in_keyboard_codes	The list of keyboard codes for keys currently down during this keyboard event.
in_modifiers	The state of modifier keys for this keyboard event.

SetActiveEvent()

void HPS::KeyboardState::SetActiveEvent

(

KeyboardEvent const &

in_event

)

Sets the active event for this KeyboardState.

Parameters

in_event

The action for this KeyboardState.

SetEventPath()

void HPS::KeyboardState::SetEventPath

(

KeyArray const &

in_path

)

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

Parameters

in_path

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

SetKeyboardCodes()

void HPS::KeyboardState::SetKeyboardCodes

(

KeyboardCodeArray const &

in_keyboard_codes

)

Sets the list of keyboard codes for keys currently down in this KeyboardState.

Parameters

in_keyboard_codes

The list of keyboard codes for keys currently down during this keyboard event.

SetModifierKeys()

void HPS::KeyboardState::SetModifierKeys

(

ModifierKeys

in_modifiers

)

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

Parameters

in_modifiers

An object representing the state of modifier keys.

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

static

---

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

• hps.h