MechanicalCameraWrapper#

class ansys.mechanical.stubs.v261.Ansys.ACT.Common.Graphics.MechanicalCameraWrapper(graphics: Ansys.ACT.Common.Graphics.MechanicalGraphicsWrapper, camera: Ansys.Common.Interop.GraphicsDataModel.IDSCameraItf)#

Bases: object

Wrapper for Camera in Mechanical.

Overview#

Equals

Equals method.

GetAsString

Retrieves the view commands as related to the application type as a string.

GetHashCode

GetHashCode method.

GetLocation

GetLocation method.

GetTarget

GetTarget method.

GetType

GetType method.

Pan

Shifts the camera position horizontally or vertically based on x and y quantities.

Rotate

Rotates the camera about an axis.

RotateView

RotateView method.

SaveUndoRedoView

SaveUndoRedoView method.

SetFit

Fits the view to the specified selection. If null is supplied, fits the view to the entire model.

SetSpecificViewOrientation

Sets a specific view orientation.

ToString

ToString method.

Zoom

Zooms in or out on the model.

ZoomRectPixels

ZoomRectPixels method.

ZoomRectSubpixels

ZoomRectSubpixels method.

FocalPoint

The focal point of the camera (coordinates are in the global coordinate system).

InternalObject

InternalObject property.

SceneHeight

Specifies the scene height (in length units) that will be projected and fit to the viewport.

SceneWidth

Specifies the scene width (in length units) that will be projected and fit to the viewport.

UpVector

The vector pointing up from the focal point.

ViewVector

The vector pointing from the focal point to the camera.

ViewportHeight

ViewportHeight property.

ViewportWidth

ViewportWidth property.

ZoomFactor

ZoomFactor property.

Property detail#

property MechanicalCameraWrapper.FocalPoint: Ansys.Mechanical.Graphics.Point | None#

The focal point of the camera (coordinates are in the global coordinate system).

property MechanicalCameraWrapper.InternalObject: Ansys.Common.Interop.GraphicsDataModel.IDSCameraItf | None#

InternalObject property.

property MechanicalCameraWrapper.SceneHeight: Ansys.Core.Units.Quantity | None#

Specifies the scene height (in length units) that will be projected and fit to the viewport.

property MechanicalCameraWrapper.SceneWidth: Ansys.Core.Units.Quantity | None#

Specifies the scene width (in length units) that will be projected and fit to the viewport.

property MechanicalCameraWrapper.UpVector: Ansys.ACT.Math.Vector3D | None#

The vector pointing up from the focal point.

property MechanicalCameraWrapper.ViewVector: Ansys.ACT.Math.Vector3D | None#

The vector pointing from the focal point to the camera.

property MechanicalCameraWrapper.ViewportHeight: int | None#

ViewportHeight property.

property MechanicalCameraWrapper.ViewportWidth: int | None#

ViewportWidth property.

property MechanicalCameraWrapper.ZoomFactor: float | None#

ZoomFactor property.

Method detail#

MechanicalCameraWrapper.Equals(obj: Any) bool#

Equals method.

MechanicalCameraWrapper.GetAsString(appType: Ansys.Mechanical.DataModel.Enums.ApplicationType) str#

Retrieves the view commands as related to the application type as a string.

MechanicalCameraWrapper.GetHashCode() int#

GetHashCode method.

MechanicalCameraWrapper.GetLocation() Ansys.ACT.Interfaces.Graphics.IWorldPoint#

GetLocation method.

MechanicalCameraWrapper.GetTarget() Ansys.ACT.Interfaces.Graphics.IWorldPoint#

GetTarget method.

MechanicalCameraWrapper.GetType() type#

GetType method.

MechanicalCameraWrapper.Pan(x: Ansys.Core.Units.Quantity, y: Ansys.Core.Units.Quantity) None#

Shifts the camera position horizontally or vertically based on x and y quantities.

MechanicalCameraWrapper.Rotate(angle: float, axis: Ansys.Mechanical.DataModel.Enums.CameraAxisType) None#

Rotates the camera about an axis.

MechanicalCameraWrapper.RotateView(angle: float) None#

RotateView method.

MechanicalCameraWrapper.SaveUndoRedoView(forcesave: int) None#

SaveUndoRedoView method.

MechanicalCameraWrapper.SetFit(sel: Ansys.ACT.Interfaces.Common.ISelectionInfo) None#

Fits the view to the specified selection. If null is supplied, fits the view to the entire model.

MechanicalCameraWrapper.SetSpecificViewOrientation(type: Ansys.Mechanical.DataModel.Enums.ViewOrientationType) None#

Sets a specific view orientation.

MechanicalCameraWrapper.ToString() str#

ToString method.

MechanicalCameraWrapper.Zoom(zoomVal: float) None#

Zooms in or out on the model.

MechanicalCameraWrapper.ZoomRectPixels(min_x: int, min_y: int, max_x: int, max_y: int) None#

ZoomRectPixels method.

MechanicalCameraWrapper.ZoomRectSubpixels(min_x: float, min_y: float, max_x: float, max_y: float) None#

ZoomRectSubpixels method.