RhinoViewport

RhinoViewport class

Displays geometry with a given projection. In standard modeling views there is a one to one relationship between RhinoView and RhinoViewports. In a page layout, there may be multiple RhinoViewports for a single layout.

Derived Classes:

Namespace: Rhino.Display
RhinoViewport: references

Constructors (2)

RhinoViewport()

RhinoViewport(RhinoViewport other)

Properties (32)

Bounds

Gets the size and location of the viewport, in pixels, relative to the parent view.

Camera35mmLensLength

CameraDirection

CameraLocation

CameraTarget

Viewport target point.

CameraUp

CameraX

Gets the "unit to the right" vector.

CameraY

Gets the "unit up" vector.

CameraZ

Gets the unit vector in CameraDirection.

ChangeCounter

The value of change counter is incremented every time the view projection or construction plane changes. The user can the mouse and nestable view manipulation commands to change a view at any time. The value of change counter can be used to detect these changes in code that is sensitive to the view projection.

ConstructionAxesVisible

ConstructionGridVisible

DisplayMode

FrustumAspect

Gets the width/height ratio of the frustum.

Unique id for this viewport.

IsParallelProjection

IsPerspectiveProjection

IsPlanView

True if construction plane z axis is parallel to camera direction.

IsTwoPointPerspectiveProjection

IsValidCamera

IsValidFrustum

LockedProjection

If true, the the camera location, camera direction, and lens angle should not be changed.

Name

Name associated with this viewport.

ParentView

Gets the parent view, if there is one Every RhinoView has an associated RhinoViewport that does all the 3d display work. Those associated viewports return the RhinoView as their parent view. However, RhinoViewports are used in other image creating contexts that do not have a parent RhinoView. If you call ParentView, you MUST check for NULL return values.

ScreenPortAspect

screen port's width/height.

Size

Get or set the height and width of the viewport (in pixels)

UserStringCount

ViewportType

WallpaperFilename

WallpaperGrayscale

WallpaperVisible

WorldAxesVisible

Methods (90)

ChangeToParallelProjection(bool symmetricFrustum)

Use this function to change projections of valid viewports from perspective to parallel. It will make common additional adjustments to the frustum so the resulting views are similar. The camera location and direction will not be changed.

ChangeToParallelReflectedProjection()

When a viewport is set to Parallel Reflected projection, the geometry on the ceiling is shown as if it is mirrored to the floor below.

ChangeToPerspectiveProjection(bool symmetricFrustum, double lensLength)

Use this function to change projections of valid viewports from parallel to perspective. It will make common additional adjustments to the frustum and camera location so the resulting views are similar. The camera direction and target point are not be changed.

ChangeToPerspectiveProjection(double targetDistance, bool symmetricFrustum, double lensLength)

ChangeToTwoPointPerspectiveProjection(double lensLength)

Use this function to change projections of valid viewports to a two point perspective. It will make common additional adjustments to the frustum and camera location and direction so the resulting views are similar.

ChangeToTwoPointPerspectiveProjection(double targetDistance,Vector3d up, double lensLength)

ClearTraceImage()

Remove trace image (background bitmap) for this viewport if one exists.

ClientToScreen(Point2d clientPoint)

ClientToScreen(Point clientPoint)

ClientToWorld(Point2d clientPoint)

ClientToWorld(Point clientPoint)

ConstructionPlane()

Simple plane information for this viewport's construction plane. If you want detailed construction plane information, use GetConstructionPlane.

DeleteAllUserStrings()

DeleteUserString(string key)

Dispose()

Dispose(bool disposing)

FromId(Guid id)

Call this method to get the viewport with the specified Id.

GetCameraAngle(out double halfDiagonalAngle, out double halfVerticalAngle, out double halfHorizontalAngle)

GetCameraExtents(IEnumerable<Point3d> points)

GetCameraFrame(out Plane frame)

Gets the camera plane.

GetConstructionPlane()

GetDepth(BoundingBox bbox, out double nearDistance, out double farDistance)

Gets near and far clipping distances of a bounding box.

GetDepth(Point3d point, out double distance)

Gets clipping distance of a point.

GetDepth(Sphere sphere, out double nearDistance, out double farDistance)

Gets near and far clipping distances of a sphere.

GetFarRect()

Get corners of far clipping plane rectangle.

GetFrustum(out double left, out double right, out double bottom, out double top, out double nearDistance, out double farDistance)

Gets the view frustum.

GetFrustumBottomPlane(out Plane plane)

Get bottom world frustum clipping plane.

GetFrustumBoundingBox()

GetFrustumCenter(out Point3d center)

Returns world coordinates of frustum's center.

GetFrustumFarPlane(out Plane plane)

Get far clipping plane.

GetFrustumLeftPlane(out Plane plane)

Get left world frustum clipping plane.

GetFrustumLine(double screenX, double screenY, out Line worldLine)

Gets the world coordinate line in the view frustum that projects to a point on the screen.

GetFrustumNearPlane(out Plane plane)

Get near clipping plane.

GetFrustumRightPlane(out Plane plane)

Get right world frustum clipping plane.

GetFrustumTopPlane(out Plane plane)

Get top world frustum clipping plane.

GetNearRect()

Get corners of near clipping plane rectangle.

GetPickTransform(int clientX, int clientY)

Takes a rectangle in screen coordinates and returns a transformation that maps the 3d frustum defined by the rectangle to a -1/+1 clipping coordinate box. This takes a single point and inflates it by Rhino.ApplicationSettings.ModelAidSettings.MousePickBoxRadius to define the screen rectangle.

GetPickTransform(Point clientPoint)

GetPickTransform(Rectangle clientRectangle)

Takes a rectangle in screen coordinates and returns a transformation that maps the 3d frustum defined by the rectangle to a -1/+1 clipping coordinate box.

GetScreenPort(out int portLeft, out int portRight, out int portBottom, out int portTop, out int portNear, out int portFar)

Location of viewport in pixels. These are provided so you can set the port you are using and get the appropriate transformations to and from screen space.

GetTransform(CoordinateSystem sourceSystem,CoordinateSystem destinationSystem)

Gets a transform from origin coordinate system to a target coordinate system.

GetUserString(string key)

Gets a user string.

GetUserStrings()

Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.

GetViewScale()

Get Scale transform applied to the viewport

GetWorldToScreenScale(Point3d pointInFrustum, out double pixelsPerUnit)

Gets the world to screen size scaling factor at a point in frustum.

IsVisible(BoundingBox bbox)

Returns True if some portion of a world coordinate bounding box is potentially visible in the viewing frustum.

IsVisible(Point3d point)

Determines if a world coordinate point is visible in the viewing frustum.

KeyboardDolly(bool leftRight, double amount)

Emulates the keyboard arrow key in terms of interaction.

KeyboardDollyInOut(double amount)

Emulates the keyboard arrow key in terms of interaction.

KeyboardRotate(bool leftRight, double angleRadians)

Emulates the keyboard arrow key in terms of interaction.

Magnify(double magnificationFactor, bool mode,Point fixedScreenPoint)

Zooms or dollies in order to scale the viewport projection of observed objects.

Magnify(double magnificationFactor, bool mode)

Zooms or dollies in order to scale the viewport projection of observed objects.

MouseAdjustLensLength(Point mousePreviousPoint,Point mouseCurrentPoint, bool moveTarget)

Adjusts the camera lens length.

MouseDollyZoom(Point mousePreviousPoint,Point mouseCurrentPoint)

Zooms lens (thus adjusting the field of view) while moving the camera.

MouseInOutDolly(Point mousePreviousPoint,Point mouseCurrentPoint)

Moves the camera towards or away from the view maintaining focus on the view.

MouseLateralDolly(Point mousePreviousPoint,Point mouseCurrentPoint)

Pans the camera

MouseMagnify(Point mousePreviousPoint,Point mouseCurrentPoint)

Moves the camera towards or away from the view.

MouseRotateAroundTarget(Point mousePreviousPoint,Point mouseCurrentPoint)

Rotates the viewport around target.

MouseRotateCamera(Point mousePreviousPoint,Point mouseCurrentPoint)

Rotates the view around the camera location.

MouseTilt(Point mousePreviousPoint,Point mouseCurrentPoint)

Tilts the camera view.

NextConstructionPlane()

Sets the construction plane to the plane that was active before the last call to PreviousConstructionPlane.

NextViewProjection()

Sets the view projection and target to the settings that were active before the last call to PrevView.

PopConstructionPlane()

Sets the construction plane to the plane that was active before the last call to PushConstructionPlane.

PopViewProjection()

Sets the view projection and target to the settings at the top of the view stack and removes those settings from the view stack.

PreviousConstructionPlane()

Sets the construction plane to the plane that was active before the last call to NextConstructionPlane or SetConstructionPlane.

PreviousViewProjection()

Sets the view projection and target to the settings that were active before the last call to NextViewProjection.

PushConstructionPlane(ConstructionPlane cplane)

Pushes the current construction plane on the viewport's construction plane stack and sets the construction plane to cplane.

PushViewInfo(ViewInfo viewinfo, bool includeTraceImage)

PushViewProjection()

Appends the current view projection and target to the viewport's view stack.

Rotate(double angleRadians, Vector3d rotationAxis, Point3d rotationCenter)

Rotates about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).

ScreenToClient(Point screenPoint)

SetCameraDirection(Vector3d cameraDirection, bool updateTargetLocation)

Set viewport camera direction. By default the target location is changed so that the vector from the camera location to the target is parallel to the camera direction.

SetCameraLocation(Point3d cameraLocation, bool updateTargetLocation)

Set viewport camera location. By default the target location is changed so that the vector from the camera location to the target is parallel to the camera direction vector.

SetCameraLocations(Point3d targetLocation, Point3d cameraLocation)

Set viewport camera location and target location. The camera direction vector is changed so that it is parallel to the vector from the camera location to the target location.

SetCameraTarget(Point3d targetLocation, bool updateCameraLocation)

Set viewport target point. By default the camera location is translated so that the camera direction vector is parallel to the vector from the camera location to the target location.

SetClippingPlanes(BoundingBox box)

Sets optimal clipping planes to view objects in a world coordinate 3d bounding box.

SetConstructionPlane(ConstructionPlane cplane)

Sets the construction plane to cplane.

SetConstructionPlane(Plane plane)

SetProjection(DefinedViewportProjection projection, string viewName, bool updateConstructionPlane)

Set viewport to a defined projection.

SetToPlanView(Point3d planeOrigin, Vector3d planeXaxis, Vector3d planeYaxis, bool setConstructionPlane)

SetTraceImage(string bitmapFileName, Plane plane, double width, double height, bool grayscale, bool filtered)

Set trace image (background bitmap) for this viewport.

SetUserString(string key, string value)

Attach a user string (key,value combination) to this geometry.

SetViewProjection(ViewportInfo projection, bool updateTargetLocation)

Sets the viewport camera projection.

SetWallpaper(string imageFilename, bool grayscale, bool visible)

SetWallpaper(string imageFilename, bool grayscale)

WorldToClient(Point3d worldPoint)

Convert a point from world coordinates in the viewport to a 2d screen point in the local coordinates of the viewport (X/Y of point is relative to top left corner of viewport on screen)

ZoomBoundingBox(BoundingBox box)

Zooms the viewport to the given bounding box.

ZoomExtents()

Dollies the camera location and so that the view frustum contains all of the selected document objects that can be seen in view. If the projection is perspective, the camera angle is not changed.

ZoomExtentsSelected()

Dollies the camera location and so that the view frustum contains all of the selected document objects that can be seen in view. If the projection is perspective, the camera angle is not changed.

ZoomWindow(Rectangle rect)

Zooms the viewport to the given rectangle.

Nothing found