Cyclone 3DR Script
from Technodigit, part of Hexagon. Copyright 1997-2022.
 
Loading...
Searching...
No Matches
SCameraExternal Class Reference

This class is only available if you have the Survey plugin.
. More...

#include <SCameraExternal.h>

Inheritance diagram for SCameraExternal:
SObject

Public Slots

static Array FromFile (String iFileName)
 Function to import an .excam file and create a new SCameraExternal from file. More...
 
Array GetOrientation ()
 Get the camera orientation in the world coordinate system. More...
 
Array GetPosition ()
 Get the camera position in the world frame. More...
 
static SCameraExternal New ()
 Default constructor. More...
 
static SCameraExternal New (SCameraExternal iOther)
 Constructs a SCameraExternal by copying the SCameraExternal Other. More...
 
 SetOrientation (Number iAngX, Number iAngY, Number iAngZ)
 Set the camera orientation from rotation angles in the world coordinate system. Angles are given in degree. More...
 
 SetPosition (SPoint iPosition)
 Set the camera position in the world frame. More...
 
String toString ()
 Get the type of the variable. More...
 
String toString ()
 Get the type of the variable. More...
 
- Public Slots inherited from SObject
 Clear ()
 To deallocate memory of the object. More...
 
String toString ()
 Get the type of the variable. More...
 

Detailed Description

This class is only available if you have the Survey plugin.
.

Warning
How to use function from namespace SCameraExternal ?
Use name of the namespace before to call function.
var result = SCameraExternal.FromFile( myPath );
This class is only available if you have the Survey plugin. .
Definition: SCameraExternal.h:30
static Array FromFile(String iFileName)
Function to import an .excam file and create a new SCameraExternal from file.

Member Function Documentation

◆ FromFile

static Array SCameraExternal::FromFile ( String  iFileName)
staticslot

Function to import an .excam file and create a new SCameraExternal from file.

Warning
In Javascript, when you write strings the '\' character is an escape character, you need to use '\\' or '/' instead. Pay especially attention to this when writing file paths in your scripts. For example :
var res = SCameraExternal.FromFile( 'C:/ExternalParams.excam' ); // Valid syntax\n
var res2 = SCameraExternal.FromFile( 'C:\\ExternalParams.excam' ); // Valid syntax\n
var res3 = SCameraExternal.FromFile( 'C:\ExternalParams.excam' ); // Invalid syntax
Return values
Array.ErrorCodeThe error code:
  • 0 No error occurred.
  • 1 An error occurred.
Array.CameraExternalThe camera external parameters.
Parameters
[in]iFileNamepath and name of the .excam file to import

◆ GetOrientation

Array SCameraExternal::GetOrientation ( )
slot

Get the camera orientation in the world coordinate system.

Return values
Array.RotXThe rotation angle around the X axis in the Euler convention in degree
Array.RotYThe rotation angle around the Y axis in the Euler convention in degree
Array.RotZThe rotation angle around the Z axis in the Euler convention in degree

◆ GetPosition

Array SCameraExternal::GetPosition ( )
slot

Get the camera position in the world frame.

Return values
Array.PointThe camera position

◆ New [1/2]

static SCameraExternal SCameraExternal::New ( )
staticslot

Default constructor.

◆ New [2/2]

static SCameraExternal SCameraExternal::New ( SCameraExternal  iOther)
staticslot

Constructs a SCameraExternal by copying the SCameraExternal Other.

◆ SetOrientation

SCameraExternal::SetOrientation ( Number  iAngX,
Number  iAngY,
Number  iAngZ 
)
slot

Set the camera orientation from rotation angles in the world coordinate system. Angles are given in degree.

◆ SetPosition

SCameraExternal::SetPosition ( SPoint  iPosition)
slot

Set the camera position in the world frame.

◆ toString [1/2]

String SCameraExternal::toString ( )
slot

Get the type of the variable.

◆ toString [2/2]

String SCameraExternal::toString ( )
slot

Get the type of the variable.