ViewportInfo

ViewportInfo class

Represents a viewing frustum.

Inheritence: Rhino.Runtime.CommonObjectViewportInfo
Derived Classes:

Namespace: Rhino.DocObjects
ViewportInfo: references

Constructors (5)

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

ViewportInfo()

Initializes a new instance.

ViewportInfo(RhinoViewport rhinoViewport)

Copies all of the ViewportInfo data from an existing RhinoViewport.

ViewportInfo(ViewportInfo other)

Initializes a new instance by copying values from another instance.

Properties (51)

Camera35mmLensLength

This property assumes the camera is horizontal and crop the film rather than the image when the aspect of the frustum is not 36/24. (35mm film is 36mm wide and 24mm high.) Setting preserves camera location, changes the frustum, but maintains the frustum's aspect.

CameraAngle

Gets or sets the 1/2 smallest angle. See GetCameraAngles for more information.

CameraDirection

Gets the direction that the camera faces.

CameraLocation

Gets the camera location (position) point.

CameraUp

Gets the camera up vector.

CameraX

Gets the unit "to the right" vector.

CameraY

Gets the unit "up" vector.

CameraZ

Gets the unit vector in -CameraDirection.

DefaultCameraDirection

Default z=up perspective camera direction

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

FrustumAspect

Setting FrustumAspect changes the larger of the frustum's width/height so that the resulting value of width/height matches the requested aspect. The camera angle is not changed. If you change the shape of the view port with a call SetScreenPort(), then you generally want to call SetFrustumAspect() with the value returned by GetScreenPortAspect().

FrustumBottom

Gets the frustum bottom value. This is -top if the frustum has a horizontal symmetry axis.
This number is usually negative.

FrustumBottomPlane

Gets the frustum bottom plane that separates visible from off-screen.

FrustumCenter

Gets the frustum center point.

FrustumFar

Gets the frustum far-cutting value.

FrustumFarPlane

Gets far clipping plane if camera and frustum are valid. The plane's frame is the same as the camera's frame. The origin is located at the intersection of the camera direction ray and the far clipping plane. The plane's normal points into the frustum towards the camera location.

FrustumHeight

Gets the frustum height. This is FrustumTop - FrustumBottom .

FrustumLeft

Gets the frustum left value. This is -right if the frustum has a vertical symmetry axis.
This number is usually negative.

FrustumLeftPlane

Gets the frustum left plane that separates visible from off-screen.

FrustumMaximumDiameter

Gets the frustum maximum diameter, or the maximum between FrustumWidth and FrustumHeight .

FrustumMinimumDiameter

Gets the frustum minimum diameter, or the minimum between FrustumWidth and FrustumHeight .

FrustumNear

Gets the frustum near-cutting value.

FrustumNearPlane

Gets near clipping plane if camera and frustum are valid. The plane's frame is the same as the camera's frame. The origin is located at the intersection of the camera direction ray and the near clipping plane. The plane's normal points out of the frustum towards the camera location.

FrustumRight

Gets the frustum right value. This is -left if the frustum has a vertical symmetry axis.
This number is usually positive.

FrustumRightPlane

Gets the frustum right plane that separates visible from off-screen.

FrustumTop

Gets the frustum top value. This is -bottom if the frustum has a horizontal symmetry axis.
This number is usually positive.

FrustumTopPlane

Gets the frustum top plane that separates visible from off-screen.

FrustumWidth

Gets the frustum width. This is FrustumRight - FrustumLeft .

HasUserData

Gets True if this class has any custom information attached to it through UserData.

Sets the viewport's id to the value used to uniquely identify this viewport. There is no approved way to change the viewport id once it is set in order to maintain consistency across multiple viewports and those routines that manage them.

IsCameraDirectionLocked

Gets or sets a value that indicates whether the direction that the camera faces is unmodifiable.

IsCameraLocationLocked

Gets or sets a value that indicates whether the camera location is unmodifiable.

IsCameraUpLocked

Gets or sets a value that indicates whether the camera up vector is unmodifiable.

IsDocumentControlled

If True this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.

IsFrustumLeftRightSymmetric

Gets or sets a value that indicates whether the camera frustum has a vertical symmetry axis.

IsFrustumTopBottomSymmetric

Gets or sets a value that indicates whether the camera frustum has a horizontal symmetry axis.

IsParallelProjection

Get or set whether this projection is parallel.

IsPerspectiveProjection

Get or set whether this projection is perspective.

IsTwoPointPerspectiveProjection

Gets a value that indicates whether this projection is a two-point perspective.

IsValid

Tests an object to see if it is valid.

IsValidCamera

Gets a value that indicates whether the camera is valid.

IsValidFrustum

Gets a value that indicates whether the frustum is valid.

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

PerspectiveMinNearDist

Expert user function to control the minimum value of near when perspective projections are being used.

PerspectiveMinNearOverFar

Expert user function to control the minimum ratio of near/far when perspective projections are begin used.

ScreenPort

Get or set the screen port. SetScreenPort(System.Drawing.Rectangle) and GetScreenPort()

ScreenPortAspect

Gets the screen aspect ratio.
This is width / height.

TargetPoint

The current value of the target point. This point does not play a role in the view projection calculations. It can be used as a fixed point when changing the camera so the visible regions of the before and after frustums both contain the region of interest. The default constructor sets this point on ON_3dPoint::UnsetPoint. You must explicitly call one SetTargetPoint() functions to set the target point.

UserData

List of custom information that is attached to this class.

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

ViewScale

Applies scaling factors to parallel projection clipping coordinates by setting the m_clip_mod transformation. If you want to compress the view projection across the viewing plane, then set x = 0.5, y = 1.0, and z = 1.0.

Methods (65)

CalculateCameraRotationAngle(Vector3d direction, Vector3d up)

Calculates the camera rotation angle.

CalculateCameraUpDirection(Point3d location, Vector3d direction, double angle)

Calculates the camera up direction.

ChangeToParallelProjection(bool symmetricFrustum)

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. If the current projection is parallel and symmetricFrustum, FrustumIsLeftRightSymmetric() and FrustumIsTopBottomSymmetric() are all equal, then no changes are made and True is returned.

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(double targetDistance, 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 changed. If the current projection is perspective and symmetricFrustum, IsFrustumIsLeftRightSymmetric, and IsFrustumIsTopBottomSymmetric are all equal, then no changes are made and True is returned.

ChangeToSymmetricFrustum(bool isLeftRightSymmetric, bool isTopBottomSymmetric, double targetDistance)

If needed, adjusts the current frustum so it has the specified symmetries and adjust the camera location so the target plane remains visible.

ChangeToTwoPointPerspectiveProjection(double targetDistance, Vector3d up, double lensLength)

Changes 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. If the current projection is perspective and IsFrustumIsLeftRightSymmetric is True and IsFrustumIsTopBottomSymmetric is false, then no changes are made and True is returned.

ConstructConstObject(object parentObject, int subobjectIndex)

Assigns a parent object and a sub-object index to this.

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

For derived class implementers.
This method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method.
You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.
Also, you must call the base virtual method within your overriding method.

DollyCamera(Vector3d dollyVector)

DollyCamera() does not update the frustum's clipping planes. To update the frustum's clipping planes call DollyFrustum(d) with d = dollyVector o cameraFrameZ. To convert screen locations into a dolly vector, use GetDollyCameraVector(). Does not update frustum. To update frustum use DollyFrustum(d) with d = dollyVector o cameraFrameZ.

DollyExtents(BoundingBox cameraCoordinateBoundingBox, double border)

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

DollyExtents(IEnumerable<GeometryBase> geometry, double border)

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

DollyFrustum(double dollyDistance)

Moves the frustum clipping planes.

EnsurePrivateCopy()

If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.

Extents(double halfViewAngleRadians, BoundingBox bbox)

Extends this viewport view to include a bounding box.
Use Extents() as a quick way to set a viewport to so that bounding volume is inside of a viewports frustum. The view angle is used to determine the position of the camera.

Extents(double halfViewAngleRadians, Sphere sphere)

Extends this viewport view to include a sphere.
Use Extents() as a quick way to set a viewport to so that bounding volume is inside of a viewports frustum. The view angle is used to determine the position of the camera.

FromBase64String(int archive3dm, int opennurbs, string base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(string json)

Create a CommonObject instance from a JSON string

FrustumCenterPoint(double targetDistance)

Return a point on the central axis of the view frustum. This point is a good choice for a general purpose target point.

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

Gets near and far clipping distances of a bounding box. This function ignores the current value of the viewport's near and far settings. If the viewport is a perspective projection, the it intersects the semi infinite frustum volume with the bounding box and returns the near and far distances of the intersection. If the viewport is a parallel projection, it intersects the infinite view region with the bounding box and returns the near and far distances of the projection.

GetCameraAngles(out double halfDiagonalAngleRadians, out double halfVerticalAngleRadians, out double halfHorizontalAngleRadians)

Gets the field of view angles.

GetCameraFrame(out Point3d location, out Vector3d cameraX, out Vector3d cameraY, out Vector3d cameraZ)

Gets location and vectors of this camera.

GetDollyCameraVector(int screenX0, int screenY0, int screenX1, int screenY1, double projectionPlaneDistance)

Gets a world coordinate dolly vector that can be passed to DollyCamera().

GetDollyCameraVector(Point screen0,Point screen1, double projectionPlaneDistance)

Gets a world coordinate dolly vector that can be passed to DollyCamera().

GetFarPlaneCorners()

Gets the corners of far clipping plane rectangle. 4 points are returned in the order of bottom left, bottom right, top left, top right.

GetFramePlaneCorners(double depth)

Gets the corners of the frame plane rectangle at specified depth. 4 points are returned in the order of bottom left, bottom right, top left, top right.

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

Gets the view frustum.

GetFrustumLine(double screenX, double screenY)

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

GetFrustumLine(Point screenPoint)

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

GetFrustumLine(PointF screenPoint)

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

GetNearPlaneCorners()

Gets the corners of near clipping plane rectangle. 4 points are returned in the order of bottom left, bottom right, top left, top right.

GetObjectData(SerializationInfo info,StreamingContext context)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

GetPointDepth(Point3d point, out double distance)

Gets the clipping distance of a point. This function ignores the current value of the viewport's near and far settings. If the viewport is a perspective projection, then it intersects the semi infinite frustum volume with the bounding box and returns the near and far distances of the intersection. If the viewport is a parallel projection, it intersects the infinite view region with the bounding box and returns the near and far distances of the projection.

GetScreenPort()

Gets the location of viewport in pixels. See documentation for SetScreenPort(int, int, int, int, int, int) .

GetScreenPort(out int near, out int far)

Gets the location of viewport in pixels.
See value meanings in SetScreenPort.

GetScreenPortLocation(out int left, out int top, out int right, out int bottom)

Get the location of viewport in pixels (non System.Drawing version of GetScreenPort)

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

Gets near and far clipping distances of a bounding sphere.

GetViewScale()

Get scaling applied to this viewport projection. Reflected ceiling projections will return the values 1,1,-1

GetWorldToScreenScale(Point3d pointInFrustum)

Gets the scale factor from point in frustum to screen scale.

GetXform(CoordinateSystem sourceSystem, CoordinateSystem destinationSystem)

Computes a transform from a coordinate system to another.

IsValidWithLog(out string log)

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

RotateCamera(double rotationAngleRadians, Vector3d rotationAxis, Point3d rotationCenter)

Rotates the view camera.

SetCameraDirection(Vector3d direction)

Sets the direction that the camera faces.

SetCameraLocation(Point3d location)

Sets the camera location (position) point.

SetCameraUp(Vector3d up)

Sets the camera up vector.

SetFrustum(double left, double right, double bottom, double top, double nearDistance, double farDistance)

Sets the view frustum. If FrustumSymmetryIsLocked() is true and left != -right or bottom != -top, then they will be adjusted so the resulting frustum is symmetric.

SetFrustumNearFar(BoundingBox boundingBox)

Sets the frustum near and far using a bounding box.

SetFrustumNearFar(double nearDistance, double farDistance, double minNearDistance, double minNearOverFar, double targetDistance)

Sets near and far clipping distance subject to constraints.

SetFrustumNearFar(double nearDistance, double farDistance)

Sets the frustum near and far distances using two values.

SetFrustumNearFar(Point3d center, double radius)

Sets the frustum near and far using a center point and radius.

SetScreenPort(int left, int right, int bottom, int top, int near, int far)

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. // For a Windows window / int width = width of window client area in pixels; / int height = height of window client area in pixels; / port_left = 0; / port_right = width; / port_top = 0; / port_bottom = height; / port_near = 0; / port_far = 1; / SetScreenPort( port_left, port_right, / port_bottom, port_top, / port_near, port_far );

SetScreenPort(Rectangle windowRectangle, int near, int far)

Gets the location of viewport in pixels.
See value meanings in SetScreenPort.

SetScreenPort(Rectangle windowRectangle)

Gets the location of viewport in pixels.
See value meanings in SetScreenPort.

SetViewScale(double scaleX, double scaleY, double scaleZ)

Set scaling applied for this viewport projection. For reflected projections, call with values 1,1,-1

TargetDistance(bool useFrustumCenterFallback)

Gets the distance from the target point to the camera plane. Note that if the frustum is not symmetric, then this distance is shorter than the distance from the target to the camera location.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

TransformCamera(Transform xform)

Transforms the view camera location, direction, and up.

UnlockCamera()

Unlocks the camera vectors and location.

UnlockFrustumSymmetry()

Unlocks frustum horizontal and vertical symmetries.

ZoomToScreenRect(int left, int top, int right, int bottom)

Zooms to a screen zone.
View changing from screen input points. Handy for using a mouse to manipulate a view. ZoomToScreenRect() may change camera and frustum settings.

ZoomToScreenRect(Rectangle windowRectangle)

Zooms to a screen zone.
View changing from screen input points. Handy for using a mouse to manipulate a view. ZoomToScreenRect() may change camera and frustum settings.

Nothing found