![]() |
Raytrix RayCam SDK
v2.1.0
|
This class represents a camera. To use the camera in streaming mode: More...
#include <IDevice.h>
Public Member Functions | |
virtual void | ApplyCameraConfiguration (void)=0 |
This will apply the set up test configuration. More... | |
virtual void | Close (void)=0 |
Closes the camera and disconnects it. More... | |
virtual void | GetProperty (ECamProperty::ID eProp, int &theValue)=0 |
Gets a camera property of type int or bool (0 represents false). More... | |
virtual void | GetProperty (ECamProperty::ID eProp, double &theValue)=0 |
Gets a camera property of type double. More... | |
virtual void | GetProperty (ECamProperty::ID eProp, long long &theValue)=0 |
Gets a camera property of type long long (0 represents false). More... | |
virtual void | GetProperty (ECamProperty::ID eProp, int &theValue1, int &theValue2)=0 |
Gets the min and max value of a camera property of type int. More... | |
virtual void | GetProperty (ECamProperty::ID eProp, double &theValue1, double &theValue2)=0 |
Gets the min and max value of a camera property of type double. More... | |
virtual void | GetProperty (ECamProperty::ID eProp, long long &theValue1, long long &theValue2)=0 |
Gets the min and max value of a camera property of type double. More... | |
virtual void | GetProperty (ECamProperty::ID eProp, void *theValue, int &theSize)=0 |
Gets a camera property of type void*. More... | |
virtual void | GetProperty (ECamProperty::ID eProp, char *theValue, int &theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | GetProperty (ECamProperty::ID eProp, wchar_t *theValue, int &theSize)=0 |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize. More... | |
virtual void | GetPropertyRange (ECamProperty::ID eProp, int &theMin, int &theMax)=0 |
Gets the min and max value of a camera property of type int. More... | |
virtual void | GetPropertyRange (ECamProperty::ID eProp, double &theMin, double &theMax)=0 |
Gets the min and max value of a camera property of type double. More... | |
virtual void | GetPropertyRange (ECamProperty::ID eProp, long long &theMin, long long &theMax)=0 |
Gets the min and max value of a camera property of type double. More... | |
virtual bool | HasProperty (ECamProperty::ID eProp)=0 |
Check if a property is available for Get/Set operations. More... | |
virtual void | LockTextureAccess ()=0 |
Locks all Texture operations when using OpenGl Texture Transfer More... | |
virtual void | Open (void)=0 |
Opens this camera device. Might throw a firmware mismatch exception which indicates that either the firmware of the camera or the firmware on your hard disk is newer. In this case, you should upgrade or downgrade the firmware to get a fully functional camera. Otherwise, if you call Open() again, the camera might me able to open but it's very likely for the camera to not work at some point. More... | |
virtual EWhiteImageStatus::ID | ProcessDevignetting (void)=0 |
Take a white image and do devignetting. This will remove vignetting artifacts. More... | |
virtual void | ProcessWhiteBalance (void)=0 |
Take a white image and do color balancing. More... | |
virtual void | RegisterCallback (void *callBackOwner, TCallbackFunction pCallbackFunction)=0 |
Registers the receive image callback specified by Rx::RayCam::TCallbackFunction. More... | |
virtual void | RegisterCallback (void *callBackOwner, TCallbackFunctionExtended pCallbackFunction)=0 |
Registers the extended receive image callback specified by Rx::RayCam::TCallbackFunction. More... | |
virtual void | Reset (void)=0 |
Resets the camera. More... | |
virtual void | SetProperty (ECamProperty::ID eProp, int newValue)=0 |
Sets a camera property of type int or bool (0 represents false). More... | |
virtual void | SetProperty (ECamProperty::ID eProp, double newValue)=0 |
Sets a camera property of type double. More... | |
virtual void | SetProperty (ECamProperty::ID eProp, long long newValue)=0 |
Sets a camera property of type long long. More... | |
virtual void | SetProperty (ECamProperty::ID eProp, int newValue1, int newValue2)=0 |
Sets a camera property with two values of type int or bool (0 represents false). More... | |
virtual void | SetProperty (ECamProperty::ID eProp, double newValue1, double newValue2)=0 |
Sets a camera property with two values of type double. More... | |
virtual void | SetProperty (ECamProperty::ID eProp, long long newValue1, long long newValue2)=0 |
Sets a camera property with two values of type double. More... | |
virtual void | SetProperty (ECamProperty::ID eProp, void *theValue, int theSize)=0 |
Sets a camera property of type void*. More... | |
virtual void | SetProperty (ECamProperty::ID eProp, char *theValue, int theSize)=0 |
Sets a camera property of type char*. The size of the buffer has to be in theSize. More... | |
virtual void | SetProperty (ECamProperty::ID eProp, wchar_t *theValue, int theSize)=0 |
Sets a camera property of type char*. The size of the buffer has to be in theSize. More... | |
virtual void | SetPropertyRange (ECamProperty::ID eProp, int newMin, int newMax)=0 |
Sets a camera property with two values of type int or bool (0 represents false). More... | |
virtual void | SetPropertyRange (ECamProperty::ID eProp, double newMin, double newMax)=0 |
Sets a camera property with two values of type double. More... | |
virtual void | SetPropertyRange (ECamProperty::ID eProp, long long newMin, long long newMax)=0 |
Sets a camera property with two values of type double. More... | |
virtual void | StartStream (Rx::RayCam::ECamTriggerMode::ID eMode)=0 |
Starts a stream in a specific mode. More... | |
virtual void | StartStreamSuspended (Rx::RayCam::ECamTriggerMode::ID eMode)=0 |
Starts a video stream but suspended. You won't receive any images until you call Rx::RayCam::IDevice::SuspendStream() with false. More... | |
virtual void | StopStream (void)=0 |
Stops a stream. The function abort pending image exposures. More... | |
virtual void | SuspendStream (bool bSuspend)=0 |
Suspend or unsuspend the camera. More... | |
virtual void | TestCameraConfiguration (double &dMinFps, double &dMaxFPS, double &dMinExposure, double &dMaxExposure)=0 |
Try set camera configuration. More... | |
virtual void | TestCameraConfiguration (void)=0 |
This will test the test configuration. More... | |
virtual void | Trigger (void)=0 |
Triggers this camera to deliver an image via the callback function Rx::RayCam::TCallbackFunction (only in Rx::RayCam::ECamTriggerMode::SoftwareSingle mode). More... | |
virtual void | UnlockTextureAccess ()=0 |
Unlocks the texture mutex when using OpenGL Texture Transfer More... | |
virtual void | UnregisterCallback (void)=0 |
Unregisters the receive image callback. More... | |
virtual void | UnregisterCallbackExtended (void)=0 |
Unregisters the extended receive image callback. More... | |
This class represents a camera. To use the camera in streaming mode:
|
pure virtual |
This will apply the set up test configuration.
|
pure virtual |
Closes the camera and disconnects it.
|
pure virtual |
Gets a camera property of type int or bool (0 represents false).
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value. |
|
pure virtual |
Gets a camera property of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value. |
|
pure virtual |
Gets a camera property of type long long (0 represents false).
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value. |
|
pure virtual |
Gets the min and max value of a camera property of type int.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue1 | [out] The first value. |
theValue2 | [out] The second value. |
|
pure virtual |
Gets the min and max value of a camera property of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue1 | [out] The first value. |
theValue2 | [out] The second value. |
|
pure virtual |
Gets the min and max value of a camera property of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue1 | [out] The first value. |
theValue2 | [out] The second value. |
|
pure virtual |
Gets a camera property of type void*.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value. |
theSize | [in,out] Size of the. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | [in,out] The size of the buffer. |
|
pure virtual |
Writes a char array into the theValue buffer. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | [in,out] The size of the buffer. |
|
pure virtual |
Gets the min and max value of a camera property of type int.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theMin | [in,out] The min value. |
theMax | [in,out] The max value. |
|
pure virtual |
Gets the min and max value of a camera property of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theMin | [in,out] The min value. |
theMax | [in,out] The max value. |
|
pure virtual |
Gets the min and max value of a camera property of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theMin | [in,out] The min value. |
theMax | [in,out] The max value. |
|
pure virtual |
Check if a property is available for Get/Set operations.
eProp | The Rx::RayCam::ECamProperty::ID property. |
|
pure virtual |
Locks all Texture operations when using OpenGl Texture Transfer
|
pure virtual |
Opens this camera device. Might throw a firmware mismatch exception which indicates that either the firmware of the camera or the firmware on your hard disk is newer. In this case, you should upgrade or downgrade the firmware to get a fully functional camera. Otherwise, if you call Open() again, the camera might me able to open but it's very likely for the camera to not work at some point.
|
pure virtual |
Take a white image and do devignetting. This will remove vignetting artifacts.
|
pure virtual |
Take a white image and do color balancing.
|
pure virtual |
Registers the receive image callback specified by Rx::RayCam::TCallbackFunction.
callBackOwner | [in,out] If non-null, the owner of the call back. |
pCallbackFunction | The callback function. |
|
pure virtual |
Registers the extended receive image callback specified by Rx::RayCam::TCallbackFunction.
callBackOwner | [in,out] If non-null, the owner of the call back. |
pCallbackFunction | The callback function. |
|
pure virtual |
Resets the camera.
|
pure virtual |
Sets a camera property of type int or bool (0 represents false).
eProp | The property. |
newValue | The new value. |
|
pure virtual |
Sets a camera property of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
newValue | The new value. |
|
pure virtual |
Sets a camera property of type long long.
eProp | The property. |
newValue | The new value. |
|
pure virtual |
Sets a camera property with two values of type int or bool (0 represents false).
eProp | The Rx::RayCam::ECamProperty::ID property. |
newValue1 | The new value1. |
newValue2 | The new value2. |
|
pure virtual |
Sets a camera property with two values of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
newValue1 | The new value1. |
newValue2 | The new value2. |
|
pure virtual |
Sets a camera property with two values of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
newValue1 | The new value1. |
newValue2 | The new value2. |
|
pure virtual |
Sets a camera property of type void*.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value. |
theSize | Size of the. |
|
pure virtual |
Sets a camera property of type char*. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | The size of the buffer. |
|
pure virtual |
Sets a camera property of type char*. The size of the buffer has to be in theSize.
eProp | The Rx::RayCam::ECamProperty::ID property. |
theValue | [in,out] The value buffer. |
theSize | The size of the buffer. |
|
pure virtual |
Sets a camera property with two values of type int or bool (0 represents false).
eProp | The Rx::RayCam::ECamProperty::ID property. |
newMin | The min value. |
newMax | The max value. |
|
pure virtual |
Sets a camera property with two values of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
newMin | The min value. |
newMax | The max value. |
|
pure virtual |
Sets a camera property with two values of type double.
eProp | The Rx::RayCam::ECamProperty::ID property. |
newMin | The min value. |
newMax | The max value. |
|
pure virtual |
Starts a stream in a specific mode.
eMode | The Rx::RayCam::ECamTriggerMode::ID trigger mode. |
|
pure virtual |
Starts a video stream but suspended. You won't receive any images until you call Rx::RayCam::IDevice::SuspendStream() with false.
eMode | The Rx::RayCam::ECamTriggerMode::ID trigger mode. |
|
pure virtual |
Stops a stream. The function abort pending image exposures.
|
pure virtual |
Suspend or unsuspend the camera.
Unsuspend the camera before you call Rx::RayCam::IDevice::StopStream()!
bSuspend | true to suspend camera, false to unsuspend. |
|
pure virtual |
Try set camera configuration.
dMinFps | [out] The minimum FPS. |
dMaxFPS | [out] The maximum FPS. |
dMinExposure | [out] The minimum exposure. |
dMaxExposure | [out] The maximum exposure. |
|
pure virtual |
This will test the test configuration.
|
pure virtual |
Triggers this camera to deliver an image via the callback function Rx::RayCam::TCallbackFunction (only in Rx::RayCam::ECamTriggerMode::SoftwareSingle mode).
|
pure virtual |
Unlocks the texture mutex when using OpenGL Texture Transfer
|
pure virtual |
Unregisters the receive image callback.
|
pure virtual |
Unregisters the extended receive image callback.