AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxOSG::NeoCameraLens Class Reference

Lens parameter specification for the NeoCamera. More...

#include <NeoCamera.h>

+ Inheritance diagram for agxOSG::NeoCameraLens:

Public Types

enum  DistortionModel : std::uint8_t { DISTORTION_NONE , DISTORTION_BROWN_CONRADY }
 

Public Member Functions

 NeoCameraLens (NeoCamera *camera)
 Initializes a camera lens with a default configuration of parameters.
 
DistortionModel getDistortionModel () const
 
const DistortionModelParameters & getDistortionModelParameters () const
 
agx::Real getFocalLength () const
 
OptionalFocusDistance getFocusDistance () const
 
agx::Real getFStop () const
 
OptionalFocusMinimumDistance getMinimumFocusDistance () const
 
bool isAutofocusEnabled () const
 
void setAutofocus (agx::Real minimumFocusDistance)
 Set the minimum focus distance for lens autofocus.
 
void setDistortionModelBrownConrady (agx::Real k1, agx::Real k2, agx::Real k3, agx::Real p1, agx::Real p2)
 Set the distortion model to the five parameter Brown-Conrady model.
 
void setDistortionModelNone ()
 Set the distortion model to no distortion.
 
void setFocalLength (agx::Real focalLength)
 Set the lens focal length.
 
void setFocusDistance (agx::Real focusDistance)
 Set the focus distance for manual focus control.
 
void setFStop (agx::Real fStop)
 Set the lens-aperture f-stop value.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

Lens parameter specification for the NeoCamera.

Definition at line 234 of file NeoCamera.h.

Member Enumeration Documentation

◆ DistortionModel

Enumerator
DISTORTION_NONE 
DISTORTION_BROWN_CONRADY 

Definition at line 237 of file NeoCamera.h.

Constructor & Destructor Documentation

◆ NeoCameraLens()

agxOSG::NeoCameraLens::NeoCameraLens ( NeoCamera *  camera)

Initializes a camera lens with a default configuration of parameters.

Parameters
camera- the camera to which the lens is attached

Member Function Documentation

◆ getDistortionModel()

DistortionModel agxOSG::NeoCameraLens::getDistortionModel ( ) const
Returns
the current distortion model used by the lens

◆ getDistortionModelParameters()

const DistortionModelParameters & agxOSG::NeoCameraLens::getDistortionModelParameters ( ) const
Returns
the current distortion model parameters

◆ getFocalLength()

agx::Real agxOSG::NeoCameraLens::getFocalLength ( ) const
Returns
the focal length of the lens

◆ getFocusDistance()

OptionalFocusDistance agxOSG::NeoCameraLens::getFocusDistance ( ) const
Returns
the manual focus distance value, if autofocus is disabled

◆ getFStop()

agx::Real agxOSG::NeoCameraLens::getFStop ( ) const
Returns
the lens-aperture f-stop value

◆ getMinimumFocusDistance()

OptionalFocusMinimumDistance agxOSG::NeoCameraLens::getMinimumFocusDistance ( ) const
Returns
the minimum focus distance of the lens, if autofocus is enabled

◆ isAutofocusEnabled()

bool agxOSG::NeoCameraLens::isAutofocusEnabled ( ) const
Returns
true if the lens has autofocus enabled

◆ setAutofocus()

void agxOSG::NeoCameraLens::setAutofocus ( agx::Real  minimumFocusDistance)

Set the minimum focus distance for lens autofocus.

Note
This will enable autofocus.
Parameters
minimumFocusDistance- minimum focus distance for the lens

◆ setDistortionModelBrownConrady()

void agxOSG::NeoCameraLens::setDistortionModelBrownConrady ( agx::Real  k1,
agx::Real  k2,
agx::Real  k3,
agx::Real  p1,
agx::Real  p2 
)

Set the distortion model to the five parameter Brown-Conrady model.

Parameters
k1- first radial coefficient
k2- second radial coefficient
k3- third radial coefficient
p1- first tangential coefficient
p2- second tangential coefficient

◆ setDistortionModelNone()

void agxOSG::NeoCameraLens::setDistortionModelNone ( )

Set the distortion model to no distortion.

◆ setFocalLength()

void agxOSG::NeoCameraLens::setFocalLength ( agx::Real  focalLength)

Set the lens focal length.

Parameters
focalLength- focal length

◆ setFocusDistance()

void agxOSG::NeoCameraLens::setFocusDistance ( agx::Real  focusDistance)

Set the focus distance for manual focus control.

Note
This will disable autofocus.
Parameters
focusDistance- focus distance for the lens

◆ setFStop()

void agxOSG::NeoCameraLens::setFStop ( agx::Real  fStop)

Set the lens-aperture f-stop value.

Parameters
fStop- f-stop value

Member Data Documentation

◆ distance

agx::Real agxOSG::NeoCameraLens::distance

Definition at line 334 of file NeoCamera.h.

◆ miniumDistance

agx::Real agxOSG::NeoCameraLens::miniumDistance

Definition at line 335 of file NeoCamera.h.


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