Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::sense::IOrientation Class Referenceabstract

Definition of Orientation interface. More...

Inheritance diagram for gem::sense::IOrientation:
Collaboration diagram for gem::sense::IOrientation:

Public Types

enum class  EOrientationType {
  Unknown = 0 , Portrait , UpsideDown , LandscapeLeft ,
  LandscapeRight
}
 Values that represent user interface orientation types. More...
enum class  EFaceType { Unknown = 0 , FaceUp , FaceDown }
 Values that represent device orientation types. More...

Public Member Functions

virtual EOrientationType getDeviceOrientation () const =0
 Get the user interface orientation.
virtual EFaceType getFaceType () const =0
 Get the device orientation.
EDataType getType () const override final
 Get data type.
virtual LargeInteger getAcquisitionTimestamp () const=0
Time getTime () const
StrongPointer< TDerivedType > cast ()
 Cast to a derived type.

Static Public Member Functions

static bool isSameType (const IData *ptr)
 Check if two data elements have the same type.

Detailed Description

Definition of Orientation interface.

Member Enumeration Documentation

◆ EFaceType

Values that represent device orientation types.

Enumerator
Unknown 

The device orientation is unknown.

FaceUp 

The device is positioned with the screen facing upwards.

FaceDown 

The device is positioned with the screen facing downwards.

◆ EOrientationType

Values that represent user interface orientation types.

Enumerator
Unknown 

The orientation is unknown.

Portrait 

The interface is in portrait orientation.

UpsideDown 

The interface is upside down (inverted portrait).

LandscapeLeft 

The interface is in landscape orientation, rotated to the left.

LandscapeRight 

The interface is in landscape orientation, rotated to the right.

Member Function Documentation

◆ cast()

StrongPointer< TDerivedType > gem::sense::IData::cast ( )
inlineinherited

Cast to a derived type.

Returns
The requested derived type as a shared pointer.

◆ getAcquisitionTimestamp()

virtual LargeInteger gem::sense::IData::getAcquisitionTimestamp ( ) const
pure virtualinherited
Returns
Acquisition timestamp in milliseconds since 1970 ( epoch )

◆ getDeviceOrientation()

virtual EOrientationType gem::sense::IOrientation::getDeviceOrientation ( ) const
pure virtual

Get the user interface orientation.

Returns
The user interface orientation.

◆ getFaceType()

virtual EFaceType gem::sense::IOrientation::getFaceType ( ) const
pure virtual

Get the device orientation.

Returns
The device orientation.

◆ getTime()

Time gem::sense::IData::getTime ( ) const
inlineinherited
Returns
System acquisition time

◆ getType()

EDataType gem::sense::IDataWithType< DerivedType >::getType ( ) const
inlinefinaloverridevirtualinherited

Get data type.

Returns
The data type.

Implements gem::sense::IData.

◆ isSameType()

bool gem::sense::IDataWithType< DerivedType >::isSameType ( const IData * ptr)
inlinestaticinherited

Check if two data elements have the same type.

Parameters
ptrThe other IData pointer to check against.
Returns
True if of same type, false if not.