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::Screen Class Reference

Class of WorldObject representing the screen in real space. More...

#include <screen.h>

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

Public Member Functions

 Screen (int resolutionHeight, int resolutionWidth, int physicalResolutionHeight, int physicalResolutionWidth, float pixelSize)
 Screen Class constructor. More...
 
const int getResolutionHeight ()
 Get the vertical resolution that is accepted by the display. More...
 
const int getResolutionWidth ()
 Get the horizontal resolution that is accepted by the display. More...
 
const int getPhysicalResolutionHeight ()
 Get the vertical native resolution of the physical screen itself. More...
 
const int getPhysicalResolutionWidth ()
 Get the horizontal native resolution of the physical screen itself. More...
 
const float getPhysicalSizeHeight ()
 Get the physical height of the screen. More...
 
const float getPhysicalSizeWidth ()
 Get the physical width of the screen. More...
 
const float getDotPitch ()
 Get the dot pitch (pixel size) More...
 
- Public Member Functions inherited from SR::WorldObject
 WorldObject (WorldObject *parent)
 
 WorldObject ()
 
cv::Vec3d getRelativePosition ()
 
cv::Vec3d getAbsolutePosition ()
 

Static Public Member Functions

static Screencreate (SRContext &context)
 Creates an instance of a Screen class. More...
 

Additional Inherited Members

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

Detailed Description

Class of WorldObject representing the screen in real space.

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

Constructor & Destructor Documentation

◆ Screen()

SR::Screen::Screen ( int  resolutionHeight,
int  resolutionWidth,
int  physicalResolutionHeight,
int  physicalResolutionWidth,
float  pixelSize 
)

Screen Class constructor.

Parameters
resolutionHeightis the vertical pixel count that is accepted by the screen
resolutionWidthis the horizontal pixel count that is accepted by the screen
physicalResolutionHeightis the vertical pixel count of the native resolution of the physical screen itself
physicalResolutionWidthis the horizontal pixel count of the native resolution of the physical screen itself
pixelSizeis the size of a pixel in cm

Member Function Documentation

◆ create()

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

Creates an instance of a Screen class.

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

◆ getDotPitch()

const float SR::Screen::getDotPitch ( )

Get the dot pitch (pixel size)

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

◆ getPhysicalResolutionHeight()

const int SR::Screen::getPhysicalResolutionHeight ( )

Get the vertical native resolution of the physical screen itself.

Returns
The vertical native resolution of the screen as an integer

◆ getPhysicalResolutionWidth()

const int SR::Screen::getPhysicalResolutionWidth ( )

Get the horizontal native resolution of the physical screen itself.

Returns
The horizontal native resolution of the screen as an integer

◆ getPhysicalSizeHeight()

const float SR::Screen::getPhysicalSizeHeight ( )

Get the physical height of the screen.

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

◆ getPhysicalSizeWidth()

const float SR::Screen::getPhysicalSizeWidth ( )

Get the physical width of the screen.

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

◆ getResolutionHeight()

const int SR::Screen::getResolutionHeight ( )

Get the vertical resolution that is accepted by the display.

Returns
The vertical resolution that is accepted by the display

◆ getResolutionWidth()

const int SR::Screen::getResolutionWidth ( )

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: