1. Home
  2. Documentation
  3. API
  4. Optical Struct Reference

Optical Struct Reference

#include <Optical.h>

Inheritance diagram for Optical:
Object

# Static Public Member Functions

static Optical getFromPixelOptical (PixelOptical pixelOptical, CameraFrustum cameraFrustum)
static Optical applyCameraFrustum (Optical optical, CameraFrustum cameraFrustum)

# Public Attributes

uint16 maximumXViewDistancePower
uint16 maximumYViewDistancePower
int16 cameraNearPlane
int16 baseDistance
int16 horizontalViewPointCenter
int16 verticalViewPointCenter
int16 scalingFactor
int16 halfWidth
int16 halfHeight
int16 aspectRatio
int16 fov
int16 aspectRatioXfov
int16 farRatio1Near
int16 farRatio2Near
int32 projectionMultiplierHelper
int32 scalingMultiplier

# Additional Inherited Members

- Private Member Functions inherited from Object
void constructor ()
 Class' constructor.
const void * getVTable ()
bool mutateTo (const void *targetClass)
- Static Private Member Functions inherited from Object
static Object getCast (void *object, ClassPointer targetClassGetClassMethod, ClassPointer baseClassGetClassMethod)
- Private Attributes inherited from Object
void * vTable
 Pointer to the class's virtual table.

# Detailed Description

Class Optical

Inherits from Object

Computes the values that determine the results from 3D to 2D projection.

Definition at line 29 of file Optical.h.

# Member Function Documentation

# applyCameraFrustum()

static Optical Optical::applyCameraFrustum ( Optical optical,
CameraFrustum cameraFrustum )
inlinestatic

Applies the provided camera frustum configuration to the provided optical configuration parameters.

Parameters
opticalStruct that holds optical parameters in meters
cameraFrustumCamera's frustum configuration parameters
Returns
Optical configuration parameters in meters

Definition at line 86 of file Optical.h.

# getFromPixelOptical()

static Optical Optical::getFromPixelOptical ( PixelOptical pixelOptical,
CameraFrustum cameraFrustum )
inlinestatic

Converts the provided optical parameters in pixel units to optical values in meters.

Parameters
pixelOpticalStruct that holds optical parameters in pixel units
cameraFrustumCamera's frustum configuration parameters
Returns
Optical configuration parameters in meters

# Member Data Documentation

# aspectRatio

int16 Optical::aspectRatio

Definition at line 210 of file Types.h.

# aspectRatioXfov

int16 Optical::aspectRatioXfov

Definition at line 212 of file Types.h.

# baseDistance

int16 Optical::baseDistance

Definition at line 204 of file Types.h.

# cameraNearPlane

int16 Optical::cameraNearPlane

Definition at line 203 of file Types.h.

# farRatio1Near

int16 Optical::farRatio1Near

Definition at line 213 of file Types.h.

# farRatio2Near

int16 Optical::farRatio2Near

Definition at line 214 of file Types.h.

# fov

int16 Optical::fov

Definition at line 211 of file Types.h.

# halfHeight

int16 Optical::halfHeight

Definition at line 209 of file Types.h.

# halfWidth

int16 Optical::halfWidth

Definition at line 208 of file Types.h.

# horizontalViewPointCenter

int16 Optical::horizontalViewPointCenter

Definition at line 205 of file Types.h.

# maximumXViewDistancePower

uint16 Optical::maximumXViewDistancePower

Definition at line 201 of file Types.h.

# maximumYViewDistancePower

uint16 Optical::maximumYViewDistancePower

Definition at line 202 of file Types.h.

# projectionMultiplierHelper

int32 Optical::projectionMultiplierHelper

Definition at line 215 of file Types.h.

# scalingFactor

int16 Optical::scalingFactor

Definition at line 207 of file Types.h.

# scalingMultiplier

int32 Optical::scalingMultiplier

Definition at line 216 of file Types.h.

# verticalViewPointCenter

int16 Optical::verticalViewPointCenter

Definition at line 206 of file Types.h.


The documentation for this struct was generated from the following files: