Iliad
Painting Plugin for UnrealEngine4 by Praxinos
Public Member Functions | List of all members
FStylusState Class Reference

Public Member Functions

 FStylusState ()
 
 FStylusState (const FStylusState &Other)
 
 FStylusState (FVector2D InPosition, float InZ, unsigned int InTimer, FVector2D InTilt, float InAzimuth, float InAltitude, float InTwist, float InPressure, float InTanPressure, FVector2D InSize, bool InDown, bool InInverted)
 
float GetAltitude () const
 
float GetAzimuth () const
 
FVector2D GetPosition () const
 
float GetPressure () const
 
FVector2D GetSize () const
 
float GetTangentPressure () const
 
FVector2D GetTilt () const
 
unsigned int GetTimer () const
 
float GetTwist () const
 
float GetZ () const
 
bool IsStylusDown () const
 
bool IsStylusInverted () const
 

Detailed Description

The current state of a single stylus, as sent by IStylusMessageHandler.

Constructor & Destructor Documentation

◆ FStylusState() [1/3]

FStylusState::FStylusState ( )
inline

◆ FStylusState() [2/3]

FStylusState::FStylusState ( FVector2D  InPosition,
float  InZ,
unsigned int  InTimer,
FVector2D  InTilt,
float  InAzimuth,
float  InAltitude,
float  InTwist,
float  InPressure,
float  InTanPressure,
FVector2D  InSize,
bool  InDown,
bool  InInverted 
)
inline

◆ FStylusState() [3/3]

FStylusState::FStylusState ( const FStylusState Other)
inline

Member Function Documentation

◆ GetAltitude()

float FStylusState::GetAltitude ( ) const
inline

The current altitude, normalized to the range of [90, 0]. Defaults to (0,0) if EStylusInputType::Orientation is not supported. A value of 90 means that the stylus is perfectly vertical. Defaults to 0 if EStylusInputType::Altitude is not supported.

◆ GetAzimuth()

float FStylusState::GetAzimuth ( ) const
inline

The current azimuth, normalized to the range of [0, 360]. A value of 0 means that the stylus is tilted forwards, away from the user. A value of 90 means that the stylus is tilted to the right direction, and so on in clockwise.

◆ GetPosition()

FVector2D FStylusState::GetPosition ( ) const
inline

The current position of the stylus on (or above) the tablet. Always valid. This value is in logical coordinates, not pixels. The mouse position can be used to retrieve the screenspace value. A value of (0,0) is in the top-left of the tablet.

◆ GetPressure()

float FStylusState::GetPressure ( ) const
inline

Get the current pressure along the tablet's normal, usually straight down. Normalized to the range [0, 1]. Defaults to 0 if EStylusInputType::Pressure is not supported.

◆ GetSize()

FVector2D FStylusState::GetSize ( ) const
inline

Get the size of the touch in logical coordinates. Defaults to (0,0) if EStylusInputType::Size is not supported.

◆ GetTangentPressure()

float FStylusState::GetTangentPressure ( ) const
inline

Get the current pressure along the tablet's surface. Normalized to the range [0, 1]. Defaults to 0 if EStylusInputType::TangentPressure is not supported.

◆ GetTilt()

FVector2D FStylusState::GetTilt ( ) const
inline

The current tilt along the X axis in degrees, normalized to the range of [-90, 90]. Defaults to (0,0) if EStylusInputType::Tilt is not supported. A value of (0,0) means that the stylus is perfectly vertical. A positive X value means that the stylus is tilted to the right. A positive Y value means that the stylus is tilted forwards, away from the user. A value of -90 or 90 means that the pen is lying on the tablet, though in practice this isn't widely supported.

◆ GetTimer()

unsigned int FStylusState::GetTimer ( ) const
inline

Elapsed time in ms from the start of the tablet context Defaults to 0 if not supported

◆ GetTwist()

float FStylusState::GetTwist ( ) const
inline

The current twist amount around the stylus' own axis in degrees, normalized to the range of [0, 360). Defaults to 0 if EStylusInputType::Twist is not supported. A value of 1 represents a full rotation clockwise.

◆ GetZ()

float FStylusState::GetZ ( ) const
inline

The current height of the stylus above the tablet. Defaults to 0 if EStylusInputType::Z is not supported.

◆ IsStylusDown()

bool FStylusState::IsStylusDown ( ) const
inline

Is the stylus currently touching the tablet?

◆ IsStylusInverted()

bool FStylusState::IsStylusInverted ( ) const
inline

Is the stylus inverted? Ie. the eraser part is pointing down. Defaults to false if EStylusInputType::Tilt is not supported.