Camera

activateClipping2D(entity, ActivatePlane)

Clip 2D: Activates clipping 2D using this plane

Alias: clip2d
Parameters:

  • entity ([Entity]) – Entity/Entities to apply the command

  • ActivatePlane (bool) – Activate a clipping plane.

activateClipping3D(entity, ActivatePlane)

Clip 3D: Activates clipping 3D using this plane

Alias: clip3d
Parameters:

  • entity ([Entity]) – Entity/Entities to apply the command

  • ActivatePlane (bool) – Activate a clipping plane.

activateTab(TabName)

Choose a tab to activate by name

Constraints: User interface
Parameters:

TabName (str) – Tab title.

changeGlobalView(ViewStyle)

Change view 3d orientation with camera coordinate system global axes

Constraints: User interface
Parameters:

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

changeProjection(ProjectionType)

: Choose the type of projection for 3d view

Constraints: User interface
Parameters:

Enumerate – { Orthogonal, Conical } ProjectionType: Projection type.

changeSelectionFilter(SelectionFilter)

Model utils: Activate the graphical selection of model utils

Alias: selFilter
Constraints: User interface
Parameters:

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

changeView(entity)

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

Constraints: User interface
Parameters:

entity ([Entity]) – Entity/Entities to apply the command

changeViewMode(ViewMode)

Contacts: Activate the contacts view mode

Alias: viewMode
Constraints: User interface
Parameters:

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

ClippingPlane(EntityName)

Obtains an entity given its name

Parameters:

EntityName (str) – Entity name.

createClippingPlane(ClippingPlaneName, Position, Normal)

Create clipping plane: Create a new clipping plane

Alias: clipPlane
Constraints: User interface
Parameters:

  • ClippingPlaneName (str) – Name: Clipping plane name. Conditions: “” input must be non-empty.

  • Position (Point) – Initial position: Initial clipping plane point. Slider central position.

  • Normal (Vector) – Normal: Clipping plane normal. Conditions: A vector cannot have zero magnitude. The input must be non-empty.

createClippingPlane2Points(ClippingPlaneName, CreationPoint1, CreationPoint2)

Create clipping by 2 points: Create a new clipping plane

Alias: clipPlane2Pnts
Constraints: User interface
Parameters:

  • ClippingPlaneName (str) – Name: Clipping plane name. Conditions: “” input must be non-empty.

  • CreationPoint1 (Point) – First point: First point to create a plane. Conditions: Matching points.

  • CreationPoint2 (Point) – Second point: Second point to create a plane. Conditions: Matching points.

createClippingPlane3Points(ClippingPlaneName, CreationPoint1, CreationPoint2, CreationPoint3)

Create clipping by 3 points: Create a new clipping plane

Alias: clipPlane3Pnts
Constraints: User interface
Parameters:

  • ClippingPlaneName (str) – Name: Clipping plane name. Conditions: “” input must be non-empty.

  • CreationPoint1 (Point) – First point: First point to create a plane. Conditions: Matching points.

  • CreationPoint2 (Point) – Second point: Second point to create a plane. Conditions: Matching points.

  • CreationPoint3 (Point) – Third point: Final point to create a plane. Conditions: Matching points. Collinear points.

createUserLabel(UserLabelName)

Create user label: Create a new user label

Constraints: User interface
Parameters:

UserLabelName (str) – Name: User label name. Conditions: “” input must be non-empty.

createUserLabel(UserLabelName, Position)

Create user label: Create a new user label

Constraints: User interface
Parameters:

  • UserLabelName (str) – Name: User label name. Conditions: “” input must be non-empty.

  • Position (Point) – Position: Label position.

createView(ViewName)

Create view: Create a new view

Constraints: User interface
Parameters:

ViewName (str) – Name: View name.

createView(ViewName, Position, Target, OrientationAngle, Up)

Create view: Create a new view

Constraints: User interface
Parameters:

  • ViewName (str) – Name: View name.

  • Position (Point) – Position: Camera position. Conditions: Matching points.

  • Target (Point) – Look at: Camera target position. Conditions: Matching points.

  • OrientationAngle (Double) – Orientation: Rotation added to the upper axis in the plane of view.

  • Up (Vector) – Up vector: Camera orientation for up axis. Conditions: A vector cannot have zero magnitude.

edgeThickness(EdgeSlider)

Rib::EdgeThicknessAmount:

Constraints: User interface
Parameters:

EdgeSlider (int) – Edge slider value between 0 and 100.

makeZoom(ZoomType)

Extent: Zoom the extent of the model

Constraints: User interface
Parameters:

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

refreshView()

Repaint the scene view

Constraints: User interface
resetHUD()

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

Constraints: User interface
rotateCamera(RotationVectorX, RotationVectorY, RotationVectorZ)

Rotates the eye around the current axis a relative angular value

Constraints: User interface
Parameters:

  • RotationVectorX (Double) – Rotation value for X axis.

  • RotationVectorY (Double) – Rotation value for Y axis.

  • RotationVectorZ (Double) – Rotation value for Z axis.

rotateView(ViewStyle)

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

Constraints: User interface
Parameters:

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

slideClipping(entity, ClipSliderValue)

Rib::ClippingPosition:

Alias: slideClip
Parameters:

  • entity ([Entity]) – Entity/Entities to apply the command

  • ClipSliderValue (int) – Clipping slider integer value from 0 to 100.

snapShot(Path)

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

Constraints: User interface
Parameters:

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

snapShot(Path, Override)

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

Constraints: User interface
Parameters:

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

  • Override (bool) – Set to true to override the file if it exists, without warning.

snapShot(Path, Width, Height)

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

Constraints: User interface
Parameters:

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

  • Width (int) – Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.

  • Height (int) – Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.

snapShot(Path, Width, Height, Override)

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

Constraints: User interface
Parameters:

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

  • Width (int) – Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.

  • Height (int) – Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.

  • Override (bool) – Set to true to override the file if it exists, without warning.

snapShot(Path, Dithering, Width, Height)

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

Constraints: User interface
Parameters:

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

  • Dithering (bool) – Dithering: Add noise to the background to avoid bands when using gradient.

  • Width (int) – Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.

  • Height (int) – Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.

snapShot(Path, Dithering, Width, Height, Override)

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

Constraints: User interface
Parameters:

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

  • Dithering (bool) – Dithering: Add noise to the background to avoid bands when using gradient.

  • Width (int) – Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.

  • Height (int) – Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.

  • Override (bool) – Set to true to override the file if it exists, without warning.

snapShot(Path, DrawScale, DrawName, Dithering, Width, Height)

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

Constraints: User interface
Parameters:

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

  • DrawScale – Draw scale: Draw the results scale.

  • DrawName – Draw file name: Draw the results file name.

  • Dithering (bool) – Dithering: Add noise to the background to avoid bands when using gradient.

  • Width (int) – Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.

  • Height (int) – Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.

snapShot(Path, DrawScale, DrawName, Dithering, Width, Height, Override)

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

Constraints: User interface
Parameters:

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

  • DrawScale – Draw scale: Draw the results scale.

  • DrawName – Draw file name: Draw the results file name.

  • Dithering (bool) – Dithering: Add noise to the background to avoid bands when using gradient.

  • Width (int) – Width: Image width (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 3840.00.

  • Height (int) – Height: Image height (pixels). Conditions: Value must be greater or equal than 1.00 and lower or equal than 2160.00.

  • Override (bool) – Set to true to override the file if it exists, without warning.

translateCamera(DistanceX, DistanceY, DistanceZ)

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

Constraints: User interface
Parameters:

  • DistanceX (Double) – Movement for X axis.

  • DistanceY (Double) – Movement for Y axis.

  • DistanceZ (Double) – Movement for Z axis.

UserLabel(EntityName)

Obtains an entity given its name

Parameters:

EntityName (str) – Entity name.

UserView(EntityName)

Obtains an entity given its name

Parameters:

EntityName (str) – Entity name.

zoomToFit(entity)

Zoom to fit:

Constraints: User interface
Parameters:

entity ([Entity]) – Entity/Entities to apply the command