Represents a viewing frustum.
Constructors
Copies all of the ViewportInfo data from an existing RhinoViewport.
Parameters:
| rhinoViewport (RhinoViewport) | A viewport to copy. |
public ViewportInfo(ViewportInfo other)
Initializes a new instance by copying values from another instance.
Parameters:
| other (ViewportInfo) | The other viewport info. |
Properties
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 of smallest subtended view angle. See GetCameraAngles(double, double, double) for more information.
Gets the direction that the camera faces.
Gets the camera location (position) point.
Default z=up perspective camera direction
Disposed
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 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 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.
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.
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.
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.
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.
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 GetScreenPort()
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.
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.
Methods
Calculates the camera rotation angle.
public static Vector3d CalculateCameraUpDirection(Point3d location, Vector3d direction, double 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.
Parameters:
| symmetricFrustum (bool) | true if you want the resulting frustum to be symmetric. |
Returns: true if the operation succeeded; otherwise, false.
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.
Returns: true if successful
public bool 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.
Parameters:
| targetDistance (double) | If RhinoMath.UnsetValue this parameter is ignored. Otherwise it must be > 0 and indicates which plane in the current view frustum should be preserved. |
| symmetricFrustum (bool) | true if you want the resulting frustum to be symmetric. |
| lensLength (double) | (pass 50.0 when in doubt) 35 mm lens length to use when changing from parallel to perspective projections. If the current projection is perspective or lens_length is <= 0.0, then this parameter is ignored. |
Returns: true if the operation succeeded; otherwise, false.
public bool 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.
Parameters:
| isLeftRightSymmetric (bool) | If true, the frustum will be adjusted so left = -right. |
| isTopBottomSymmetric (bool) | If true, the frustum will be adjusted so top = -bottom. |
| targetDistance (double) | If projection is not perspective or target_distance is RhinoMath.UnsetValue, then this parameter is ignored. If the projection is perspective and targetDistance is not RhinoMath.UnsetValue, then it must be > 0.0 and it is used to determine which plane in the old frustum will appear unchanged in the new frustum. |
Returns: Returns true if the viewport has now a frustum with the specified symmetries.
public bool 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.
Parameters:
| targetDistance (double) | If RhinoMath.UnsetValue this parameter is ignored. Otherwise it must be > 0 and indicates which plane in the current view frustum should be preserved. |
| up (Vector3d) | The locked up direction. Pass Vector3d.Zero if you want to use the world axis direction that is closest to the current up direction. Pass CameraY() if you want to preserve the current up direction. |
| lensLength (double) | (pass 50.0 when in doubt) 35 mm lens length to use when changing from parallel to perspective projections. If the current projection is perspective or lens_length is <= 0.0, then this parameter is ignored. |
Returns: true if the operation succeeded; otherwise, false.
ConstructConstObject
Assigns a parent object and a sub-object index to this.
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
Dispose
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.
Parameters:
| disposing (bool) | true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer. |
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.
Parameters:
| dollyVector (Vector3d) | dolly vector in world coordinates. |
Returns: true if the operation succeeded; otherwise, false.
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.
Parameters:
| cameraCoordinateBoundingBox (BoundingBox) | |
| border (double) | If border > 1.0, then the frustum is enlarged by this factor to provide a border around the view. If 0.0 < border < 1.0, then the frustum is shrunk by this factor and the objects will extend past the edges of the view. A border of 0.0 or 1.0 adds no border. 1.1 works well for parallel projections; 0.0 is suggested for perspective projections. |
Returns: True if successful.
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.
Parameters:
| geometry (IEnumerable<GeometryBase>) | |
| border (double) | If border > 1.0, then the frustum is enlarged by this factor to provide a border around the view. If 0.0 < border < 1.0, then the frustum is shrunk by this factor and the objects will extend past the edges of the view. A border of 0.0 or 1.0 adds no border. 1.1 works well for parallel projections; 0.0 is suggested for perspective projections. |
Returns: True if successful.
Moves the frustum clipping planes.
Parameters:
| dollyDistance (double) | Distance to move in camera direction. |
Returns: true if the operation succeeded; otherwise, false.
EnsurePrivateCopy
public void 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.
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.
Parameters:
| halfViewAngleRadians (double) | 1/2 smallest subtended view angle in radians. |
| bbox (BoundingBox) | A bounding box in 3d world coordinates. |
Returns: true if the operation succeeded; otherwise, false.
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.
Parameters:
| targetDistance (double) | If targetDistance > 0.0, then the distance from the returned point to the camera plane will be targetDistance. Note that if the frustum is not symmetric, the distance from the returned point to the camera location will be larger than targetDistance. If targetDistance == ON_UNSET_VALUE and the frustum is valid with near > 0.0, then 0.5*(near + far) will be used as the targetDistance. |
Returns: A point on the frustum's central axis. If the viewport or input is not valid, then ON_3dPoint::UnsetPoint is returned.
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.
Parameters:
| bbox (BoundingBox) | The bounding box to sample. |
| nearDistance (out double) | Near distance of the box. This value can be zero or negative when the camera location is inside box. |
| farDistance (out double) | Far distance of the box. This value can be equal to near_dist, zero or negative when the camera location is in front of the bounding box. |
Returns: true if the bounding box intersects the view frustum and near_dist/far_dist were set. false if the bounding box does not intersect the view frustum.
public bool GetCameraAngles(out double halfDiagonalAngleRadians, out double halfVerticalAngleRadians, out double halfHorizontalAngleRadians)
Gets the field of view angles.
Parameters:
| halfDiagonalAngleRadians (out double) | 1/2 of diagonal subtended angle. This out parameter is assigned during this call. |
| halfVerticalAngleRadians (out double) | 1/2 of vertical subtended angle. This out parameter is assigned during this call. |
| halfHorizontalAngleRadians (out double) | 1/2 of horizontal subtended angle. This out parameter is assigned during this call. |
Returns: true if the operation succeeded; otherwise, false.
public bool GetCameraFrame(out Point3d location, out Vector3d cameraX, out Vector3d cameraY, out Vector3d cameraZ)
Gets location and vectors of this camera.
Parameters:
| location (out Point3d) | An out parameter that will be filled with a point during the call. |
| cameraX (out Vector3d) | An out parameter that will be filled with the X vector during the call. |
| cameraY (out Vector3d) | An out parameter that will be filled with the Y vector during the call. |
| cameraZ (out Vector3d) | An out parameter that will be filled with the Z vector during the call. |
Returns: true if current camera orientation is valid; otherwise false.
public Vector3d GetDollyCameraVector(int screenX0, int screenY0, int screenX1, int screenY1, double projectionPlaneDistance)
Gets a world coordinate dolly vector that can be passed to DollyCamera().
Parameters:
| screenX0 (int) | Screen coordinates of start point. |
| screenY0 (int) | Screen coordinates of start point. |
| screenX1 (int) | Screen coordinates of end point. |
| screenY1 (int) | Screen coordinates of end point. |
| projectionPlaneDistance (double) | Distance of projection plane from camera. When in doubt, use 0.5*(frus_near+frus_far). |
Returns: The world coordinate dolly vector.
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.
Returns: Four corner points on success. Empty array if viewport is not valid.
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.
Parameters:
| depth (double) | Distance from camera location. |
Returns: Four corner points on success. Empty array if viewport is not valid.
public bool GetFrustum(out double left, out double right, out double bottom, out double top, out double nearDistance, out double farDistance)
Gets the view frustum.
Parameters:
| left (out double) | A left value that will be filled during the call. |
| right (out double) | A right value that will be filled during the call. |
| bottom (out double) | A bottom value that will be filled during the call. |
| top (out double) | A top value that will be filled during the call. |
| nearDistance (out double) | A near distance value that will be filled during the call. |
| farDistance (out double) | A far distance value that will be filled during the call. |
Returns: true if operation succeeded; otherwise, false.
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.
Parameters:
| screenPoint (Point) | screen location |
Returns: 3d world coordinate line segment starting on the near clipping plane and ending on the far clipping plane.
Gets the world coordinate line in the view frustum that projects to a point on the screen.
Parameters:
| screenPoint (PointF) | screen location |
Returns: 3d world coordinate line segment starting on the near clipping plane and ending on the far clipping plane.
Gets the corners of near clipping plane rectangle. 4 points are returned in the order of bottom left, bottom right, top left, top right.
Returns: Four corner points on success. Empty array if viewport is not valid.
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
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.
Returns: The rectangle, or Empty rectangle on error.
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.
Parameters:
| sphere (Sphere) | The sphere to sample. |
| nearDistance (out double) | Near distance of the sphere (can be < 0) |
| farDistance (out double) | Far distance of the sphere (can be equal to near_dist) |
Returns: true if the sphere intersects the view frustum and near_dist/far_dist were set. false if the sphere does not intersect the view frustum.
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.
Parameters:
| pointInFrustum (Point3d) | point in viewing frustum. |
Returns: number of pixels per world unit at the 3d point.
Computes a transform from a coordinate system to another.
Parameters:
| sourceSystem (CoordinateSystem) | The coordinate system to map from. |
| destinationSystem (CoordinateSystem) | The coordinate system to map into. |
Returns: The 4x4 transformation matrix (acts on the left).
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: true if this object is valid; false otherwise.
NonConstOperation
protected virtual void NonConstOperation()
For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.
OnSwitchToNonConst
protected virtual void OnSwitchToNonConst()
Is called when a non-constant operation first occurs.
public bool RotateCamera(double rotationAngleRadians, Vector3d rotationAxis, Point3d rotationCenter)
Rotates the view camera.
Sets the direction that the camera faces.
Parameters:
| direction (Vector3d) | A new direction. |
Returns: true if the direction was set; otherwise false.
Sets the camera location (position) point.
Parameters:
| location (Point3d) |
Returns: true if the operation succeeded; otherwise, false.
Sets the camera up vector.
Parameters:
| up (Vector3d) | A new direction. |
Returns: true if the direction was set; otherwise false.
public bool 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.
Sets the frustum near and far using a bounding box.
Parameters:
| boundingBox (BoundingBox) | A bounding box to use. |
Returns: true if operation succeeded; otherwise, false.
public bool SetFrustumNearFar(double nearDistance, double farDistance, double minNearDistance, double minNearOverFar, double targetDistance)
Sets near and far clipping distance subject to constraints.
Parameters:
| nearDistance (double) | (>0) desired near clipping distance. |
| farDistance (double) | (>near_dist) desired near clipping distance. |
| minNearDistance (double) | If min_near_dist <= 0.0, it is ignored. If min_near_dist > 0 and near_dist < min_near_dist, then the frustum's near_dist will be increased to min_near_dist. |
| minNearOverFar (double) | If min_near_over_far <= 0.0, it is ignored. If near_dist < far_dist*min_near_over_far, then near_dist is increased and/or far_dist is decreased so that near_dist = far_dist*min_near_over_far. If near_dist < target_dist < far_dist, then near_dist near_dist is increased and far_dist is decreased so that projection precision will be good at target_dist. Otherwise, near_dist is simply set to far_dist*min_near_over_far. |
| targetDistance (double) | If target_dist <= 0.0, it is ignored. If target_dist > 0, it is used as described in the description of the min_near_over_far parameter. |
Returns: true if operation succeeded; otherwise, false.
Sets the frustum near and far distances using two values.
Sets the frustum near and far using a center point and radius.
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 );
Gets the location of viewport in pixels.
See value meanings in SetScreenPort.
Gets the location of viewport in pixels.
See value meanings in SetScreenPort.
Parameters:
| windowRectangle (Rectangle) | A new rectangle. |
Returns: true if input is valid.
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.
Parameters:
| useFrustumCenterFallback (bool) | If bUseFrustumCenterFallback is false and the target point is not valid, then ON_UNSET_VALUE is returned. If bUseFrustumCenterFallback is true and the frustum is valid and current target point is not valid or is behind the camera, then 0.5*(near + far) is returned. |
Returns: Shortest signed distance from camera plane to target point. If the target point is on the visible side of the camera, a positive value is returned. ON_UNSET_VALUE is returned when the input of view is not valid.
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |
Transforms the view camera location, direction, and up.
Parameters:
| xform (Transform) | Transformation to apply to camera. |
Returns: True if a valid camera was transformed, false if invalid camera, frustum, or transformation.
public void UnlockFrustumSymmetry()
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.
Parameters:
| windowRectangle (Rectangle) | The new window rectangle in screen space. |
Returns: true if the operation succeeded; otherwise, false.