Simulated Reality SDK 7500c78d v1.30.2.51085 2024-04-26T11:23:03Z
Stable
Public Member Functions | Static Public Member Functions | List of all members
SR::Display Class Referenceabstract

Class of WorldObject representing the SR display in real space. More...

#include <display.h>

Inheritance diagram for SR::Display:
[legend]
Collaboration diagram for SR::Display:
[legend]

Public Member Functions

virtual ~Display ()=default
 Destructor of the Display instance. More...
 
virtual const int getResolutionHeight ()=0
 Get the vertical resolution that is accepted by the display. More...
 
virtual const int getResolutionWidth ()=0
 Get the horizontal resolution that is accepted by the display. More...
 
virtual const int getPhysicalResolutionHeight ()=0
 Get the vertical native resolution of the physical display itself. More...
 
virtual const int getPhysicalResolutionWidth ()=0
 Get the horizontal native resolution of the physical display itself. More...
 
virtual const float getPhysicalSizeHeight ()=0
 Get the physical height of the display. More...
 
virtual const float getPhysicalSizeWidth ()=0
 Get the physical width of the display. More...
 
virtual const float getDotPitch ()=0
 Get the dot pitch (pixel size) More...
 
virtual SR_recti getLocation ()=0
 Finds the SR monitor and return it's location in the display configuration. More...
 
- Public Member Functions inherited from SR::WorldObject
 WorldObject (WorldObject *parent)
 
 WorldObject ()
 
cv::Vec3d getRelativePosition ()
 
cv::Vec3d getAbsolutePosition ()
 

Static Public Member Functions

static Displaycreate (SRContext &context)
 Creates an instance of a Display class. More...
 

Additional Inherited Members

- Protected Attributes inherited from SR::WorldObject
WorldObjectparent
 
Transformation parentRelation
 
cv::Vec3d relativePosition
 

Detailed Description

Class of WorldObject representing the SR display in real space.

The origin of both worlds is at the center of the display

Constructor & Destructor Documentation

◆ ~Display()

virtual SR::Display::~Display ( )
virtualdefault

Destructor of the Display instance.

Explicitly defined because Impl is an incomplete type when this header is evaluated. The destructor is implemented in the implementation file because the Impl class is fully defined there.

Member Function Documentation

◆ create()

static Display * SR::Display::create ( SRContext context)
static

Creates an instance of a Display class.

Parameters
contextis the environment in which created senses are kept track of
Returns
A pointer to the Display instance

◆ getDotPitch()

virtual const float SR::Display::getDotPitch ( )
pure virtual

Get the dot pitch (pixel size)

Returns
The dot pitch (pixel size) as a float number in cm

◆ getLocation()

virtual SR_recti SR::Display::getLocation ( )
pure virtual

Finds the SR monitor and return it's location in the display configuration.

Returns
A rectangle representing the position and virtual size of the display in the display configuration

◆ getPhysicalResolutionHeight()

virtual const int SR::Display::getPhysicalResolutionHeight ( )
pure virtual

Get the vertical native resolution of the physical display itself.

Returns
The vertical native resolution of the display as an integer

◆ getPhysicalResolutionWidth()

virtual const int SR::Display::getPhysicalResolutionWidth ( )
pure virtual

Get the horizontal native resolution of the physical display itself.

Returns
The horizontal native resolution of the display as an integer

◆ getPhysicalSizeHeight()

virtual const float SR::Display::getPhysicalSizeHeight ( )
pure virtual

Get the physical height of the display.

Returns
The physical height of the display as a float number in cm

◆ getPhysicalSizeWidth()

virtual const float SR::Display::getPhysicalSizeWidth ( )
pure virtual

Get the physical width of the display.

Returns
The physical width of the display as a float number in cm

◆ getResolutionHeight()

virtual const int SR::Display::getResolutionHeight ( )
pure virtual

Get the vertical resolution that is accepted by the display.

Returns
The vertical resolution that is accepted by the display

◆ getResolutionWidth()

virtual const int SR::Display::getResolutionWidth ( )
pure virtual

Get the horizontal resolution that is accepted by the display.

Returns
The horizontal resolution that is accepted by the display

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