# Camera
```{eval-rst}
.. py:function:: activateClipping2D(entity, ActivatePlane)
    :nocontentsentry:

    Clip 2D: Activates clipping 2D using this plane

    |  Alias: clip2d

    :param [Entity] entity: Entity/Entities to apply the command
    :param bool ActivatePlane: Activate a clipping plane. 
```

```{eval-rst}
.. py:function:: activateClipping3D(entity, ActivatePlane)
    :nocontentsentry:

    Clip 3D: Activates clipping 3D using this plane

    |  Alias: clip3d

    :param [Entity] entity: Entity/Entities to apply the command
    :param bool ActivatePlane: Activate a clipping plane. 
```

```{eval-rst}
.. py:function:: activateTab(TabName)
    :nocontentsentry:

    Choose a tab to activate by name

    |  Constraints: User interface

    :param str TabName: Tab title. 
```

```{eval-rst}
.. py:function:: changeGlobalView(ViewStyle)
    :nocontentsentry:

    Change view 3d orientation with camera coordinate system global axes

    |  Constraints: User interface

    :param Enumerate: { XNegative, XPositive, YNegative, YPositive, ZNegative, ZPositive } ViewStyle: View style. 
```

```{eval-rst}
.. py:function:: changeProjection(ProjectionType)
    :nocontentsentry:

    : Choose the type of projection for 3d view

    |  Constraints: User interface

    :param Enumerate: { Orthogonal, Conical } ProjectionType: Projection type. 
```

```{eval-rst}
.. py:function:: changeSelectionFilter(SelectionFilter)
    :nocontentsentry:

    Model utils: Activate the graphical selection of model utils

    |  Alias: selFilter
    |  Constraints: User interface

    :param Enumerate: { None, SelectPoints, SelectCurves, SelectSurfaces, SelectVolumes, SelectSE, SelectSEElements, SelectSENodes, SelectCoordSys, SelectModelUtils } SelectionFilter: Filter selection to change from activated to deactivated or vice versa. 
```

```{eval-rst}
.. py:function:: changeView(entity)
    :nocontentsentry:

    Look at: Change the view using the selected in the combo box

    |  Constraints: User interface

    :param [Entity] entity: Entity/Entities to apply the command
```

```{eval-rst}
.. py:function:: changeViewMode(ViewMode)
    :nocontentsentry:

    Contacts: Activate the contacts view mode

    |  Alias: viewMode
    |  Constraints: User interface

    :param Enumerate: { Geometry, SE, Contact } ViewMode: New visualization mode. 
```

```{eval-rst}
.. py:function:: ClippingPlane(EntityName)
    :nocontentsentry:

    Obtains an entity given its name


    :param str EntityName: Entity name. 
```

```{eval-rst}
.. py:function:: createClippingPlane(ClippingPlaneName, Position, Normal)
    :nocontentsentry:

    Create clipping plane: Create a new clipping plane

    |  Alias: clipPlane
    |  Constraints: User interface

    :param str ClippingPlaneName: Name: Clipping plane name. Conditions: "" input must be non-empty.
    :param Point Position: Initial position: Initial clipping plane point. Slider central position. 
    :param Vector Normal: Normal: Clipping plane normal. Conditions: A vector cannot have zero magnitude. The input must be non-empty.
```

```{eval-rst}
.. py:function:: createClippingPlane2Points(ClippingPlaneName, CreationPoint1, CreationPoint2)
    :nocontentsentry:

    Create clipping by 2 points: Create a new clipping plane

    |  Alias: clipPlane2Pnts
    |  Constraints: User interface

    :param str ClippingPlaneName: Name: Clipping plane name. Conditions: "" input must be non-empty.
    :param Point CreationPoint1: First point: First point to create a plane. Conditions: Matching points.
    :param Point CreationPoint2: Second point: Second point to create a plane. Conditions: Matching points.
```

```{eval-rst}
.. py:function:: createClippingPlane3Points(ClippingPlaneName, CreationPoint1, CreationPoint2, CreationPoint3)
    :nocontentsentry:

    Create clipping by 3 points: Create a new clipping plane

    |  Alias: clipPlane3Pnts
    |  Constraints: User interface

    :param str ClippingPlaneName: Name: Clipping plane name. Conditions: "" input must be non-empty.
    :param Point CreationPoint1: First point: First point to create a plane. Conditions: Matching points.
    :param Point CreationPoint2: Second point: Second point to create a plane. Conditions: Matching points.
    :param Point CreationPoint3: Third point: Final point to create a plane. Conditions: Matching points. Collinear points.
```

```{eval-rst}
.. py:function:: createUserLabel(UserLabelName)
    :nocontentsentry:

    Create user label: Create a new user label

    |  Constraints: User interface

    :param str UserLabelName: Name: User label name. Conditions: "" input must be non-empty.
```

```{eval-rst}
.. py:function:: createUserLabel(UserLabelName, Position)
    :nocontentsentry:

    Create user label: Create a new user label

    |  Constraints: User interface

    :param str UserLabelName: Name: User label name. Conditions: "" input must be non-empty.
    :param Point Position: Position: Label position. 
```

```{eval-rst}
.. py:function:: createView(ViewName)
    :nocontentsentry:

    Create view: Create a new view

    |  Constraints: User interface

    :param str ViewName: Name: View name. 
```

```{eval-rst}
.. py:function:: createView(ViewName, Position, Target, OrientationAngle, Up)
    :nocontentsentry:

    Create view: Create a new view

    |  Constraints: User interface

    :param str ViewName: Name: View name. 
    :param Point Position: Position: Camera position. Conditions: Matching points.
    :param Point Target: Look at: Camera target position. Conditions: Matching points.
    :param Double OrientationAngle: Orientation: Rotation added to the upper axis in the plane of view. 
    :param Vector Up: Up vector: Camera orientation for up axis. Conditions: A vector cannot have zero magnitude.
```

```{eval-rst}
.. py:function:: edgeThickness(EdgeSlider)
    :nocontentsentry:

    Rib::EdgeThicknessAmount: 

    |  Constraints: User interface

    :param int EdgeSlider: Edge slider value between 0 and 100. 
```

```{eval-rst}
.. py:function:: makeZoom(ZoomType)
    :nocontentsentry:

    Extent: Zoom the extent of the model

    |  Constraints: User interface

    :param Enumerate: { ZoomIn, ZoomOut, Fit } ZoomType: Zoom type. 
```

```{eval-rst}
.. py:function:: refreshView()
    :nocontentsentry:

    Repaint the scene view

    |  Constraints: User interface

```

```{eval-rst}
.. py:function:: resetHUD()
    :nocontentsentry:

    Reset HUD: Restore the default positions and HUD bars mode (Heads-Up Display)

    |  Constraints: User interface

```

```{eval-rst}
.. py:function:: rotateCamera(RotationVectorX, RotationVectorY, RotationVectorZ)
    :nocontentsentry:

    Rotates the eye around the current axis a relative angular value

    |  Constraints: User interface

    :param Double RotationVectorX: Rotation value for X axis. 
    :param Double RotationVectorY: Rotation value for Y axis. 
    :param Double RotationVectorZ: Rotation value for Z axis. 
```

```{eval-rst}
.. py:function:: rotateView(ViewStyle)
    :nocontentsentry:

    Rotate the view in the given direction the angles set in the configuration

    |  Constraints: User interface

    :param Enumerate: { XNegative, XPositive, YNegative, YPositive, ZNegative, ZPositive } ViewStyle: View style. 
```

```{eval-rst}
.. py:function:: slideClipping(entity, ClipSliderValue)
    :nocontentsentry:

    Rib::ClippingPosition: 

    |  Alias: slideClip

    :param [Entity] entity: Entity/Entities to apply the command
    :param int ClipSliderValue: Clipping slider integer value from 0 to 100. 
```

```{eval-rst}
.. py:function:: snapShot(Path)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
```

```{eval-rst}
.. py:function:: snapShot(Path, Override)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
    :param bool Override: Set to true to override the file if it exists, without warning. 
```

```{eval-rst}
.. py:function:: snapShot(Path, Width, Height)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
    :param int Width: Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.
    :param int Height: Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.
```

```{eval-rst}
.. py:function:: snapShot(Path, Width, Height, Override)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
    :param int Width: Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.
    :param int Height: Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.
    :param bool Override: Set to true to override the file if it exists, without warning. 
```

```{eval-rst}
.. py:function:: snapShot(Path, Dithering, Width, Height)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
    :param bool Dithering: Dithering: Add noise to the background to avoid bands when using gradient. 
    :param int Width: Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.
    :param int Height: Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.
```

```{eval-rst}
.. py:function:: snapShot(Path, Dithering, Width, Height, Override)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
    :param bool Dithering: Dithering: Add noise to the background to avoid bands when using gradient. 
    :param int Width: Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.
    :param int Height: Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.
    :param bool Override: Set to true to override the file if it exists, without warning. 
```

```{eval-rst}
.. py:function:: snapShot(Path, DrawScale, DrawName, Dithering, Width, Height)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
    :param  DrawScale: Draw scale: Draw the results scale. 
    :param  DrawName: Draw file name: Draw the results file name. 
    :param bool Dithering: Dithering: Add noise to the background to avoid bands when using gradient. 
    :param int Width: Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.
    :param int Height: Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.
```

```{eval-rst}
.. py:function:: snapShot(Path, DrawScale, DrawName, Dithering, Width, Height, Override)
    :nocontentsentry:

    Capture: Capture a snapshot of the graphical view and store it in a file

    |  Constraints: User interface

    :param Path Path: Path to store: Path to store the image (png, bmp, jpg or gif extension). 
    :param  DrawScale: Draw scale: Draw the results scale. 
    :param  DrawName: Draw file name: Draw the results file name. 
    :param bool Dithering: Dithering: Add noise to the background to avoid bands when using gradient. 
    :param int Width: Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.
    :param int Height: Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.
    :param bool Override: Set to true to override the file if it exists, without warning. 
```

```{eval-rst}
.. py:function:: translateCamera(DistanceX, DistanceY, DistanceZ)
    :nocontentsentry:

    Movement of the eye and view point parallel to the current axis

    |  Constraints: User interface

    :param Double DistanceX: Movement for X axis. 
    :param Double DistanceY: Movement for Y axis. 
    :param Double DistanceZ: Movement for Z axis. 
```

```{eval-rst}
.. py:function:: UserLabel(EntityName)
    :nocontentsentry:

    Obtains an entity given its name


    :param str EntityName: Entity name. 
```

```{eval-rst}
.. py:function:: UserView(EntityName)
    :nocontentsentry:

    Obtains an entity given its name


    :param str EntityName: Entity name. 
```

```{eval-rst}
.. py:function:: zoomToFit(entity)
    :nocontentsentry:

    Zoom to fit: 

    |  Constraints: User interface

    :param [Entity] entity: Entity/Entities to apply the command
```