Raytrix Light Field SDK  5.0
Rx::LFR::Net::Camera Class Reference

Detailed Description

A camera.

Inherits Rx::Net::NativeInterfaceWrapper< Rx::LFR::CCamera, Rx::LFR::Net::Interfaces::ECamera >.

Public Member Functions

 Camera ()
 Default constructor. More...
 
 Camera (Rx::LFR::CCamera &xNative)
 Constructor. More...
 
 ~Camera ()
 Destructor. More...
 
void Close ()
 Closes the camera. Does nothing if not open. More...
 
virtual System::Object ^ GetInterface (Interfaces::ECamera eInterface) override
 Gets the interface of the CUDA compute class determined by the ECudaComputeInterface enum. More...
 
virtual System::Object ^ GetInterface (Rx::LFR::Net::Interfaces::ECamera eData)
 Gets the interface. More...
 
void GetProperty (InteropNet::Runtime30::Camera::EProperty eProp, RX_OUT float % fValue)
 Gets a property. More...
 
void GetProperty (InteropNet::Runtime30::Camera::EProperty eProp, RX_OUT int % iValue)
 Gets a property. More...
 
void GetProperty (InteropNet::Runtime30::Camera::EProperty eProp, RX_OUT System::String^ % sValue)
 Gets the value of a string property. More...
 
void GetPropertyRange (InteropNet::Runtime30::Camera::EProperty eProp, RX_OUT array< int >^ % aiValues)
 Gets the possible values of an integer property. More...
 
void GetPropertyRange (InteropNet::Runtime30::Camera::EProperty eProp, RX_OUT float % fMin, RX_OUT float % fMax)
 Gets the property range of the given arguments. More...
 
void GetPropertyRange (InteropNet::Runtime30::Camera::EProperty eProp, RX_OUT int % iMin, RX_OUT int % iMax)
 Gets the property range of the given arguments. More...
 
delegate void ImageCapturedHandler (Rx::Net::Image^ xImage, unsigned uCamIdx)
 Handler of image captured events. More...
 
bool IsPropertyAvailable (InteropNet::Runtime30::Camera::EProperty eProp)
 Queries if a property is available. More...
 
void Open ()
 Opens the camera. More...
 
void SetProperty (InteropNet::Runtime30::Camera::EProperty eProp, float fValue)
 Sets a property. More...
 
void SetProperty (InteropNet::Runtime30::Camera::EProperty eProp, int iValue)
 Sets a property. More...
 
void SetProperty (InteropNet::Runtime30::Camera::EProperty eProp, System::String^ sValue)
 Sets the value of a string property. More...
 
void Start ()
 Starts a capture. More...
 
void Start (InteropNet::Runtime30::Camera::ETriggerMode eTriggerMode)
 Starts the camera. The given trigger mode determines when the camera captures images. More...
 
void Stop ()
 Stops a capture. More...
 
void Suspend (bool bSuspend)
 Suspend capture. More...
 
void Trigger ()
 Triggers this object. More...
 

Static Public Member Functions

static bool operator== (Camera^ xCamera1, Camera^ xCamera2)
 Equality operator. More...
 

Properties

System::String^ DriverName [get]
 Gets the name of the driver. More...
 
System::String^ HardwareID [get]
 Gets the hardware ID. More...
 
Rx::Net::ImageFormatImageFormat [get]
 Gets the format of the images captured by this camera. More...
 
unsigned Index [get]
 Gets the camera index. This is the index in the list of cameras in the camera server. More...
 
System::String^ InternalSerial [get]
 Gets the internal serial of the camera More...
 
bool IsOpen [get]
 Query if this camera is open. More...
 

Events

ImageCapturedHandlerImageCaptured [add, remove]
 Event queue for all listeners interested in ImageCaptured events. Attention: he image has to be copied before the image data is allowed to be changed More...
 

Constructor & Destructor Documentation

◆ Camera() [1/2]

Rx::LFR::Net::Camera::Camera ( )
inline

Default constructor.

◆ Camera() [2/2]

Rx::LFR::Net::Camera::Camera ( Rx::LFR::CCamera xNative)
inline

Constructor.

Wraps the given native instance instead of creating an own instance. The given native instance must be valid for the lifetime of this instance.

Parameters
xNative[in] The native instance to be wrapped by this class.

◆ ~Camera()

Rx::LFR::Net::Camera::~Camera ( )
inline

Destructor.

Member Function Documentation

◆ Close()

void Rx::LFR::Net::Camera::Close ( )
inline

Closes the camera. Does nothing if not open.

◆ GetInterface() [1/2]

virtual System::Object ^ Rx::LFR::Net::Camera::GetInterface ( Interfaces::ECamera  eInterface)
inlineoverridevirtual

Gets the interface of the CUDA compute class determined by the ECudaComputeInterface enum.

Parameters
eInterface[in] The interface enum.
Returns
Null if no interface is implemented yet, else the interface object.

◆ GetInterface() [2/2]

virtual System::Object ^ Rx::Net::NativeInterfaceWrapper< Rx::LFR::CCamera , Rx::LFR::Net::Interfaces::ECamera >::GetInterface ( Rx::LFR::Net::Interfaces::ECamera  eData)
inlinevirtualinherited

Gets the interface.

Returns
The interface.

◆ GetProperty() [1/3]

void Rx::LFR::Net::Camera::GetProperty ( InteropNet::Runtime30::Camera::EProperty  eProp,
RX_OUT float %  fValue 
)
inline

Gets a property.

Parameters
eProp[in] The property.
fValue[out] The value.

◆ GetProperty() [2/3]

void Rx::LFR::Net::Camera::GetProperty ( InteropNet::Runtime30::Camera::EProperty  eProp,
RX_OUT int %  iValue 
)
inline

Gets a property.

Parameters
eProp[in] The property.
iValue[out] Zero-based index of the value.

◆ GetProperty() [3/3]

void Rx::LFR::Net::Camera::GetProperty ( InteropNet::Runtime30::Camera::EProperty  eProp,
RX_OUT System::String^ %  sValue 
)
inline

Gets the value of a string property.

Parameters
eProp[in] The property.
sValue[out] The string value.

◆ GetPropertyRange() [1/3]

void Rx::LFR::Net::Camera::GetPropertyRange ( InteropNet::Runtime30::Camera::EProperty  eProp,
RX_OUT array< int >^ %  aiValues 
)
inline

Gets the possible values of an integer property.

Parameters
eProp[in] The property.
aiValues[out] The values.

◆ GetPropertyRange() [2/3]

void Rx::LFR::Net::Camera::GetPropertyRange ( InteropNet::Runtime30::Camera::EProperty  eProp,
RX_OUT float %  fMin,
RX_OUT float %  fMax 
)
inline

Gets the property range of the given arguments.

Parameters
eProp[in] The property.
fMin[out] The minimum.
fMax[out] The maximum.

◆ GetPropertyRange() [3/3]

void Rx::LFR::Net::Camera::GetPropertyRange ( InteropNet::Runtime30::Camera::EProperty  eProp,
RX_OUT int %  iMin,
RX_OUT int %  iMax 
)
inline

Gets the property range of the given arguments.

Parameters
eProp[in] The property.
iMin[out] Zero-based index of the minimum.
iMax[out] Zero-based index of the maximum.

◆ ImageCapturedHandler()

delegate void Rx::LFR::Net::Camera::ImageCapturedHandler ( Rx::Net::Image xImage,
unsigned  uCamIdx 
)

Handler of image captured events.

    Attention:
            The image has to be copied before the image data is allowed to be changed, otherwise the original camera image could
            be destroyed!
Parameters
xImage[in,out] The captured image.
uCamIdx[in] The index of the camera in the camera server.

◆ IsPropertyAvailable()

bool Rx::LFR::Net::Camera::IsPropertyAvailable ( InteropNet::Runtime30::Camera::EProperty  eProp)
inline

Queries if a property is available.

Parameters
eProp[in] The property.
Returns
True if a property is available, false if not.

◆ Open()

void Rx::LFR::Net::Camera::Open ( )
inline

Opens the camera.

◆ operator==()

static bool Rx::LFR::Net::Camera::operator== ( Camera xCamera1,
Camera xCamera2 
)
inlinestatic

Equality operator.

Parameters
xCamera1[in] If non-null, the first instance to compare.
xCamera2[in] If non-null, the second instance to compare.
Returns
True if the parameters are considered equivalent.

◆ SetProperty() [1/3]

void Rx::LFR::Net::Camera::SetProperty ( InteropNet::Runtime30::Camera::EProperty  eProp,
float  fValue 
)
inline

Sets a property.

Parameters
eProp[in] The property.
fValue[in] The value.

◆ SetProperty() [2/3]

void Rx::LFR::Net::Camera::SetProperty ( InteropNet::Runtime30::Camera::EProperty  eProp,
int  iValue 
)
inline

Sets a property.

Parameters
eProp[in] The property.
iValue[in] Zero-based index of the value.

◆ SetProperty() [3/3]

void Rx::LFR::Net::Camera::SetProperty ( InteropNet::Runtime30::Camera::EProperty  eProp,
System::String^  sValue 
)
inline

Sets the value of a string property.

Parameters
eProp[in] The property.
sValue[in] The string value.

◆ Start() [1/2]

void Rx::LFR::Net::Camera::Start ( )
inline

Starts a capture.

◆ Start() [2/2]

void Rx::LFR::Net::Camera::Start ( InteropNet::Runtime30::Camera::ETriggerMode  eTriggerMode)
inline

Starts the camera. The given trigger mode determines when the camera captures images.

Parameters
eTriggerMode[in] The trigger mode.

◆ Stop()

void Rx::LFR::Net::Camera::Stop ( )
inline

Stops a capture.

◆ Suspend()

void Rx::LFR::Net::Camera::Suspend ( bool  bSuspend)
inline

Suspend capture.

Parameters
bSuspend[in] true to suspend.

◆ Trigger()

void Rx::LFR::Net::Camera::Trigger ( )
inline

Triggers this object.

Property Documentation

◆ DriverName

System:: String^ Rx::LFR::Net::Camera::DriverName
get

Gets the name of the driver.

◆ HardwareID

System:: String^ Rx::LFR::Net::Camera::HardwareID
get

Gets the hardware ID.

◆ ImageFormat

Rx:: Net:: ImageFormat^ Rx::LFR::Net::Camera::ImageFormat
get

Gets the format of the images captured by this camera.

◆ Index

unsigned Rx::LFR::Net::Camera::Index
get

Gets the camera index. This is the index in the list of cameras in the camera server.

◆ InternalSerial

System:: String^ Rx::LFR::Net::Camera::InternalSerial
get

Gets the internal serial of the camera

◆ IsOpen

bool Rx::LFR::Net::Camera::IsOpen
get

Query if this camera is open.

Event Documentation

◆ ImageCaptured

ImageCapturedHandler^ Rx::LFR::Net::Camera::ImageCaptured
addremove

Event queue for all listeners interested in ImageCaptured events. Attention: he image has to be copied before the image data is allowed to be changed