ViewportInfo Class

Initializes a new instance.

Copies all of the ViewportInfo data from an existing RhinoViewport.

Initializes a new instance by copying values from another instance.

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.

Gets or sets the 1/2 smallest angle. See GetCameraAngles(Double, Double, Double) for more information.

Gets the direction that the camera faces.

Gets the camera location (position) point.

Gets the camera up vector.

Gets the unit "to the right" vector.

Gets the unit "up" vector.

Gets the unit vector in -CameraDirection.

Default z=up perspective camera direction

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

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().

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

This number is usually negative.

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

Gets the frustum center point.

Gets the frustum far-cutting value.

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.

Gets the frustum height. This is FrustumTop - FrustumBottom.

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

This number is usually negative.

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

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

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

Gets the frustum near-cutting value.

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.

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

This number is usually positive.

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

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

This number is usually positive.

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

Gets the frustum width. This is FrustumRight - FrustumLeft.

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.

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

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

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

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.

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

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

Get or set whether this projection is parallel.

Get or set whether this projection is perspective.

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

Tests an object to see if it is valid.

Gets a value that indicates whether the camera is valid.

Gets a value that indicates whether the frustum is valid.

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

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

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

Gets the screen aspect ratio.

This is width / height.

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.

List of custom information that is attached to this class.

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

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.

Calculates the camera rotation angle.

Calculates the camera up direction.

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.

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.

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

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.

Actively reclaims unmanaged resources that this instance uses.

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.

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.

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.

Moves the frustum clipping planes.

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.

Determines whether the specified object is equal to the current object.

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.

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.

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

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.

Gets the field of view angles.

Gets location and vectors of this camera.

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

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

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

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.

Gets the view frustum.

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

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

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

Serves as the default hash function.

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

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

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.

Gets the location of viewport in pixels. See documentation for SetScreenPort.

Gets the location of viewport in pixels.

See value meanings in SetScreenPort.

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

Gets near and far clipping distances of a bounding sphere.

Gets the Type of the current instance.

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

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

Computes a transform from a coordinate system to another.

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

Rotates the view camera.

Sets the direction that the camera faces.

Sets the camera location (position) point.

Sets the camera up vector.

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.

Sets the frustum near and far using a bounding box.

Sets the frustum near and far distances using two values.

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

Sets near and far clipping distance subject to constraints.

Gets the location of viewport in pixels.

See value meanings in SetScreenPort.

Gets the location of viewport in pixels.

See value meanings in SetScreenPort.

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 );

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

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.

Create a JSON string representation of this object

Returns a string that represents the current object.

Transforms the view camera location, direction, and up.

Unlocks the camera vectors and location.

Unlocks frustum horizontal and vertical symmetries.

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.

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.