pycatia.in_interfaces.cameras

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.in_interfaces.cameras.Cameras(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
Cameras

A collection of all the Camera objects currently attached to a Document
object.
A camera can be created using the Viewer.NewCamera method of the Viewer object.
The first seventh cameras of the collection are Camera3D objects and cannot be
modified or removed. They can just be retrieved and used “as is”. They store
the following viewpoints whose sight direction is always toward the 3D-axis
system origin:

* iso
The origin is on a line with (1,1,1) as components with positive
coordinates
* front
The origin is on the x axis with a positive x coordinate
* back
The origin is on the x axis with a negative x coordinate
* left
The origin is on the y axis with a positive y coordinate
* right
The origin is on the y axis with a negative y coordinate
* top
The origin is on the z axis with a positive z coordinate
* bottom
The origin is on the z axis with a negative z coordinate

The cameras of the Cameras collection are available using the dialog box
displayed by clicking the View->Defined Views menu.
item(i_index: cat_variant) → Camera

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Item(CATVariant iIndex) As Camera

Returns a camera using its index or its name from the Cameras
collection.

Parameters:

iIndex
The index or the name of the camera to retrieve from the collection
of cameras. As a numerics, this index is the rank of the camera in the
collection. The index of the first camera in the collection is 1, and the index
of the last camera is Count. As a string, it is the name you assigned to the
camera using the

AnyObject.Name property.
Returns:
The retrieved camera
Example:
This example retrieves in ThisCamera the ninth camera, and in
ThatCamera the camera named MyCamera in the camera collection of the active
document.

Dim ThisCamera As Camera
Set ThisCamera = CATIA.ActiveDocument.Cameras.Item(9)
Dim ThatCamera As Camera
Set ThatCamera = CATIA.ActiveDocument.Cameras.Item(“MyCamera”)
Parameters:

i_index (cat_variant) –

Return type:

Camera

remove(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub Remove(CATVariant iIndex)

Removes a camera from the Cameras collection.

Parameters:

iIndex
The index or the name of the camera to remove from the collection
of cameras. As a numerics, this index is the rank of the camera in the
collection. The index of the first camera in the collection is 1, and the index
of the last camera is Count. As a string, it is the name you assigned to the
camera using the

AnyObject.Name property. You cannot remove the first seventh cameras in
the collection.

Example:
The following example removes the tenth camera and the camera named
CameraToBeRemoved in the camera collection of the active
document.

CATIA.ActiveDocument.Cameras.Remove(10)
CATIA.ActiveDocument.Cameras.Remove(“CameraToBeRemoved”)
Parameters:

i_index (cat_variant) –

Return type:

None