The PtzController class can be created for a device that has pan, tilt, and/or zoom functionality. More...

#include <PtzController.h>

Public Types
enum	IrisDirections { IrisDirections::Stop, IrisDirections::Close, IrisDirections::Open }
	Values that represent iris directions. More...

enum	FocusDirections { FocusDirections::Stop, FocusDirections::Far, FocusDirections::Near }
	Values that represent focus directions. More...

enum	ZoomDirections { ZoomDirections::None, ZoomDirections::Stop, ZoomDirections::In, ZoomDirections::Out }
	Values that represent zoom directions. More...

Public Member Functions
	PtzController (VxSdk::IVxPtzController *ptzController)
	Constructor. More...

virtual	~PtzController ()
	Destructor. More...

	!PtzController ()
	Finaliser. More...

Results::Value	AbsoluteMove (int positionX, int positionY)
	Move to the absolute position of the given coordinates. More...

Results::Value	AbsoluteMove (int positionX, int positionY, int positionZ)
	Move to the absolute position of the given coordinates. More...

Results::Value	AbsolutePan (int positionX)
	Pan to the absolute position of the given coordinate. More...

Results::Value	AbsoluteTilt (int positionY)
	Tilt to the absolute position of the given coordinate. More...

Results::Value	AbsoluteZoom (int positionZ)
	Zoom to the absolute position of the given coordinates. More...

Results::Value	AddPreset (int index)
	Creates a new preset using the current PTZ spatial coordinates. More...

Results::Value	ContinuousFocus (FocusDirections nearFar)
	Focus near or far until the user wants to stop. More...

Results::Value	ContinuousIris (IrisDirections openClose)
	Open or close the iris until the user wants to stop. More...

Results::Value	ContinuousMove (int speedX, int speedY, ZoomDirections inOut)
	Continuously move the field of view at the given speed until stopped. More...

CPPCli::Results::Value	DeletePreset (Preset^ preset)
	Deletes a preset from the system. More...

System::Collections::Generic::List< Pattern^ >^	GetPatterns ()
	Get the available patterns. More...

System::Collections::Generic::List< Preset^ >^	GetPresets ()
	Get the available presets. More...

Results::Value	Refresh ()
	Update this instances properties. More...

Results::Value	RelativeMove (int deltaX, int deltaY, int deltaZ)
	Moves the camera position relative to the current position. More...

Results::Value	RelativePercentageMove (int percentageX, int percentageY)
	Moves the camera position within a percentage relative to the device�s current field of view. More...

Results::Value	RepositionPreset (Preset^ preset)
	Repositions a preset to the current PTZ spatial coordinates. More...

Results::Value	Stop ()
	Stops all PTZ actions. More...

Results::Value	TriggerPattern (Pattern^ pattern)
	Trigger a pattern. More...

Results::Value	TriggerPreset (int index)
	Triggers a preset by index. More...

Results::Value	TriggerPreset (Preset^ preset)
	Trigger a preset. More...

Results::Value	TriggerRefresh ()
	Triggers a refresh of this PtzController on the VideoXpert system; updating its patterns and presets based on the current camera configuration. More...

Package Functions
PtzLimits^	_GetPtzLimits ()

PtzLock^	_GetPtzLock ()

Package Attributes
VxSdk::IVxPtzController *	_ptzController

Properties
bool	IsLocked `[get]`
	Gets a value indicating whether the PTZ control is locked. More...

int	LockExpireTime `[get]`
	Gets the time remaining (in seconds) until the PTZ lock expires. More...

PtzLimits^	PTZLimits `[get]`
	Gets the PtzLimits for this ptz controller. More...

PtzLock^	PTZLock `[get]`
	Gets the PtzLock associated with this ptz controller. More...

int	X `[get]`
	Gets the X coordinate absolute position (pan). More...

int	Y `[get]`
	Gets the Y coordinate absolute position (tilt). More...

int	Z `[get]`
	Gets the Z coordinate absolute position (zoom). More...

Detailed Description

The PtzController class can be created for a device that has pan, tilt, and/or zoom functionality.

Definition at line 15 of file PtzController.h.

Member Enumeration Documentation

enum CPPCli::PtzController::FocusDirections

strong

Values that represent focus directions.

Enumerator
Stop	Stop focus movement.
Far	Focus far.
Near	Focus near.

Definition at line 36 of file PtzController.h.

enum CPPCli::PtzController::IrisDirections

strong

Values that represent iris directions.

Enumerator
Stop	Stop iris movement.
Close	Close the iris.
Open	Open the iris.

Definition at line 21 of file PtzController.h.

         {
             Stop,
 
             Close,
 
             Open
         };

enum CPPCli::PtzController::ZoomDirections

strong

Values that represent zoom directions.

Enumerator
None	Do not perform a zoom action.
Stop	Stop zoom movement.
In	Zoom in.
Out	Zoom out.

Definition at line 51 of file PtzController.h.

Constructor & Destructor Documentation

CPPCli::PtzController::PtzController ( VxSdk::IVxPtzController * ptzController )

Constructor.

Parameters

ptzController The ptz controller.

Definition at line 8 of file PtzController.cpp.

                                                                        {
     _ptzController = ptzController;
 }

virtual CPPCli::PtzController::~PtzController ( )

inlinevirtual

Destructor.

Definition at line 75 of file PtzController.h.

                                  {
             this->!PtzController();
         }

CPPCli::PtzController::!PtzController ( )

Finaliser.

Definition at line 12 of file PtzController.cpp.

                                     {
     _ptzController->Delete();
     _ptzController = nullptr;
 }

Member Function Documentation

CPPCli::PtzLimits CPPCli::PtzController::_GetPtzLimits ( )

package

Definition at line 177 of file PtzController.cpp.

                                                     {
     // Get the ptz limit values from the ptz controller
     VxSdk::VxPtzLimits* ptzLimits = nullptr;
     VxSdk::VxResult::Value result = _ptzController->GetPtzLimits(ptzLimits);
 
     // Return the ptz limits if GetPtzLimits was successful
     if (result == VxSdk::VxResult::kOK)
         return gcnew PtzLimits(ptzLimits);
 
     return nullptr;
 }

CPPCli::PtzLock CPPCli::PtzController::_GetPtzLock ( )

package

Definition at line 189 of file PtzController.cpp.

                                                 {
     // Get the ptz lock which allows the client to make lock the ptz controller
     VxSdk::IVxPtzLock* ptzLock = nullptr;
     VxSdk::VxResult::Value result = _ptzController->GetPtzLock(ptzLock);
 
     // Return the ptz lock if GetPtzLock was successful
     if (result == VxSdk::VxResult::kOK)
         return gcnew PtzLock(ptzLock);
 
     return nullptr;
 }

CPPCli::Results::Value CPPCli::PtzController::AbsoluteMove	(	int	positionX,
		int	positionY
	)

Move to the absolute position of the given coordinates.

Parameters

positionX	The X coordinate absolute position (pan).
positionY	The Y coordinate absolute position (tilt).

Returns: The Result of the absolute move.

Definition at line 17 of file PtzController.cpp.

                                                                                  {
     // Call AbsoluteMove and return the result
     VxSdk::VxResult::Value result = _ptzController->AbsoluteMove(positionX, positionY);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::AbsoluteMove	(	int	positionX,
		int	positionY,
		int	positionZ
	)

Move to the absolute position of the given coordinates.

Parameters

positionX	The X coordinate absolute position (pan).
positionY	The Y coordinate absolute position (tilt).
positionZ	The Z coordinate absolute position (zoom).

Returns: The Result of the absolute move.

Definition at line 23 of file PtzController.cpp.

                                                                                                 {
     // Call AbsoluteMove and return the result
     VxSdk::VxResult::Value result = _ptzController->AbsoluteMove(positionX, positionY, positionZ);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::AbsolutePan ( int positionX )

Pan to the absolute position of the given coordinate.

Parameters

positionX The X coordinate absolute position (pan).

Returns: The Result of the absolute pan.

Definition at line 29 of file PtzController.cpp.

                                                                  {
     // Call AbsolutePan and return the result
     VxSdk::VxResult::Value result = _ptzController->AbsolutePan(positionX);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::AbsoluteTilt ( int positionY )

Tilt to the absolute position of the given coordinate.

Parameters

positionY The Y coordinate absolute position (tilt).

Returns: The Result of the absolute tilt.

Definition at line 35 of file PtzController.cpp.

                                                                   {
     // Call AbsoluteTilt and return the result
     VxSdk::VxResult::Value result = _ptzController->AbsoluteTilt(positionY);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::AbsoluteZoom ( int positionZ )

Zoom to the absolute position of the given coordinates.

Parameters

positionZ The Z coordinate absolute position (zoom).

Returns: The Result of the absolute zoom.

Definition at line 41 of file PtzController.cpp.

                                                                   {
     // Call AbsoluteZoom and return the result
     VxSdk::VxResult::Value result = _ptzController->AbsoluteZoom(positionZ);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::AddPreset ( int index )

Creates a new preset using the current PTZ spatial coordinates.

Parameters

index The unique index value for the new preset.

Returns: The Result of the adding the preset.

Definition at line 47 of file PtzController.cpp.

                                                            {
     // Call AddPreset and return the result
     VxSdk::VxResult::Value result = _ptzController->AddPreset(index);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::ContinuousFocus ( FocusDirections nearFar )

Focus near or far until the user wants to stop.

Parameters

nearFar The direction to focus.

Returns: The Result of the focus call.

Definition at line 53 of file PtzController.cpp.

                                                                                                   {
     // Call ContinuousFocus and return the result
     VxSdk::VxResult::Value result = _ptzController->ContinuousFocus((VxSdk::VxFocusDirection::Value)nearFar);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::ContinuousIris ( IrisDirections openClose )

Open or close the iris until the user wants to stop.

Parameters

openClose The direction to change the iris.

Returns: The Result of the iris call.

Definition at line 59 of file PtzController.cpp.

                                                                                                   {
     // Call ContinuousIris and return the result
     VxSdk::VxResult::Value result = _ptzController->ContinuousIris((VxSdk::VxIrisDirection::Value)openClose);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::ContinuousMove	(	int	speedX,
		int	speedY,
		ZoomDirections	inOut
	)

Continuously move the field of view at the given speed until stopped.

Parameters

speedX	Pan speed. Negative values pan left, positive values pan right.
speedY	Tilt speed. Negative values tilt downward, positive values tilt upward.
inOut	The direction to zoom.

Returns: The Result of the continuous move.

Definition at line 65 of file PtzController.cpp.

                                                                                                                       {
     // Call ContinuousMove and return the result
     VxSdk::VxResult::Value result = _ptzController->ContinuousMove(speedX, speedY, (VxSdk::VxZoomDirection::Value)inOut);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::DeletePreset ( Preset^ preset )

Deletes a preset from the system.

Parameters

preset The Preset to delete.

Returns: The Result of deleting the preset.

Definition at line 71 of file PtzController.cpp.

                                                                    {
     // Call DeletePreset and return the result
     VxSdk::VxResult::Value result = _ptzController->DeletePreset(*preset->_preset);
     return CPPCli::Results::Value(result);
 }

List< CPPCli::Pattern^ > CPPCli::PtzController::GetPatterns ( )

Get the available patterns.

Returns: A List of patterns.

Definition at line 77 of file PtzController.cpp.

                                                        {
     // Create a list of managed pattern objects
     List<Pattern^>^ mlist = gcnew List<Pattern^>();
     // Create a collection of unmanaged pattern objects
     VxSdk::VxCollection<VxSdk::IVxPattern**> patterns;
 
     // Make the GetPatterns call, which will return with the total pattern count, this allows the client to allocate memory.
     VxSdk::VxResult::Value result = _ptzController->GetPatterns(patterns);
     // As long as the datasource has at least one pattern the GetPatterns call should return VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Fill the array of pointers to the proper size as determined by the previous GetPatterns call
         patterns.collection = new VxSdk::IVxPattern*[patterns.collectionSize];
         result = _ptzController->GetPatterns(patterns);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < patterns.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::Pattern(patterns.collection[i]));
         }
         // Delete the memory allocated earlier
         delete[] patterns.collection;
     }
     return mlist;
 }

List< CPPCli::Preset^ > CPPCli::PtzController::GetPresets ( )

Get the available presets.

Returns: A List of presets.

Definition at line 101 of file PtzController.cpp.

                                                      {
     // Create a list of managed preset objects
     List<Preset^>^ mlist = gcnew List<Preset^>();
     // Create a collection of unmanaged preset objects
     VxSdk::VxCollection<VxSdk::IVxPreset**> presets;
 
     // Make the GetPresets call, which will return with the total preset count, this allows the client to allocate memory.
     VxSdk::VxResult::Value result = _ptzController->GetPresets(presets);
     // As long as the datasource has at least one preset the GetPresets call should return VxSdk::VxResult::kInsufficientSize
     if (result == VxSdk::VxResult::kInsufficientSize) {
         // Fill the array of pointers to the proper size as determined by the previous GetPresets call
         presets.collection = new VxSdk::IVxPreset*[presets.collectionSize];
         result = _ptzController->GetPresets(presets);
         // The result should now be kOK since we have allocated enough space
         if (result == VxSdk::VxResult::kOK) {
             for (int i = 0; i < presets.collectionSize; i++)
                 mlist->Add(gcnew CPPCli::Preset(presets.collection[i]));
         }
         // Delete the memory allocated earlier
         delete[] presets.collection;
     }
     return mlist;
 }

CPPCli::Results::Value CPPCli::PtzController::Refresh ( )

Update this instances properties.

Returns: The Result of updating the properties.

Definition at line 125 of file PtzController.cpp.

                                                 {
     return (CPPCli::Results::Value)_ptzController->Refresh();
 }

CPPCli::Results::Value CPPCli::PtzController::RelativeMove	(	int	deltaX,
		int	deltaY,
		int	deltaZ
	)

Moves the camera position relative to the current position.

Parameters

deltaX	The degree to pan relative to the current X position. Negative values pan left, positive values pan right.
deltaY	The degree to tilt relative to the current Y position. Negative values pan left, positive values pan right.
deltaZ	The magnification level relative to the current Z position. Negative values pan left, positive values pan right.

Returns: The Result of the relative move.

Definition at line 129 of file PtzController.cpp.

                                                                                        {
     // Call RelativeMove and return the result
     VxSdk::VxResult::Value result = _ptzController->RelativeMove(deltaX, deltaY, deltaZ);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::RelativePercentageMove	(	int	percentageX,
		int	percentageY
	)

Moves the camera position within a percentage relative to the device�s current field of view.

The rotational x and y parameters are used to move within a percentage of the current field of view of the camera. For instance, if the x parameter were 50 and the y parameter were -50, the pan/tilt would move halfway to the edge of the field of view along the x axis and halfway to the field of view along the negative y axis from its present position.

Parameters

percentageX	Percentage of the current field of view of the camera (X axis). Positive values are to the right, negative values are to the left. Range: -100 to 100.
percentageY	Percentage of the current field of view of the camera (Y axis). Positive values are up, negative values are down. Range: -100 to 100.

Returns: The Result of the relative percentage move.

Definition at line 135 of file PtzController.cpp.

                                                                                                {
     // Call RelativePercentageMove and return the result
     VxSdk::VxResult::Value result = _ptzController->RelativePercentageMove(percentageX, percentageY);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::RepositionPreset ( Preset^ preset )

Repositions a preset to the current PTZ spatial coordinates.

Parameters

preset The Preset to reposition.

Returns: The Result of repositioning the preset.

Definition at line 141 of file PtzController.cpp.

                                                                        {
     // Call RepositionPreset and return the result
     VxSdk::VxResult::Value result = _ptzController->RepositionPreset(*preset->_preset);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::Stop ( )

Stops all PTZ actions.

Returns: The Result of the stop call.

Definition at line 147 of file PtzController.cpp.

                                              {
     // Call PtzStop and return the result
     VxSdk::VxResult::Value result = _ptzController->PtzStop();
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::TriggerPattern ( Pattern^ pattern )

Trigger a pattern.

Parameters

pattern The Pattern to trigger.

Returns: The Result of triggering the pattern.

Definition at line 153 of file PtzController.cpp.

                                                                        {
     // Call TriggerPattern and return the result
     VxSdk::VxResult::Value result = _ptzController->TriggerPattern(*pattern->_pattern);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::TriggerPreset ( int index )

Triggers a preset by index.

Parameters

index The index of the preset to trigger.

Returns: The Result of triggering the preset.

Definition at line 159 of file PtzController.cpp.

                                                                {
     // Call TriggerPreset and return the result
     VxSdk::VxResult::Value result = _ptzController->TriggerPreset(index);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::TriggerPreset ( Preset^ preset )

Trigger a preset.

Parameters

preset The Preset to trigger.

Returns: The Result of triggering the preset.

Definition at line 165 of file PtzController.cpp.

                                                                     {
     // Call TriggerPreset and return the result
     VxSdk::VxResult::Value result = _ptzController->TriggerPreset(*preset->_preset);
     return CPPCli::Results::Value(result);
 }

CPPCli::Results::Value CPPCli::PtzController::TriggerRefresh ( )

Triggers a refresh of this PtzController on the VideoXpert system; updating its patterns and presets based on the current camera configuration.

Returns: The Result of refreshing the PtzController.

Definition at line 171 of file PtzController.cpp.

                                                        {
     // Call TriggerRefresh and return the result
     VxSdk::VxResult::Value result = _ptzController->TriggerRefresh();
     return CPPCli::Results::Value(result);
 }

Member Data Documentation

VxSdk::IVxPtzController* CPPCli::PtzController::_ptzController

package

Definition at line 321 of file PtzController.h.

Property Documentation

bool CPPCli::PtzController::IsLocked

get

Gets a value indicating whether the PTZ control is locked.

true if locked, false if not.

Definition at line 249 of file PtzController.h.

int CPPCli::PtzController::LockExpireTime

get

Gets the time remaining (in seconds) until the PTZ lock expires.

The expire time in seconds.

Definition at line 258 of file PtzController.h.

PtzLimits^ CPPCli::PtzController::PTZLimits

get

Gets the PtzLimits for this ptz controller.

nullptr if no ptz limits are available, else the PtzLimits.

Definition at line 267 of file PtzController.h.

PtzLock^ CPPCli::PtzController::PTZLock

get

Gets the PtzLock associated with this ptz controller.

nullptr if no ptz lock is available, else the PtzLock.

Definition at line 276 of file PtzController.h.

int CPPCli::PtzController::X

get

Gets the X coordinate absolute position (pan).

The current X coordinate.

Definition at line 285 of file PtzController.h.

int CPPCli::PtzController::Y

get

Gets the Y coordinate absolute position (tilt).

The current Y coordinate.

Definition at line 298 of file PtzController.h.

int CPPCli::PtzController::Z

get

Gets the Z coordinate absolute position (zoom).

The current Z coordinate.

Definition at line 311 of file PtzController.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/PtzController.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/PtzController.cpp

Public Types

Public Member Functions

Package Functions

Package Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation