com.esri.arcgis.analyst3d
Class Camera

java.lang.Object
  com.esri.arcgis.analyst3d.Camera

All Implemented Interfaces:

ICamera, ICamera2, ICamera3, IStereoCamera, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class Camera
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICamera, ICamera2, ICamera3, IStereoCamera

The ESRI camera component.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

Camera()
Constructs a Camera using ArcGIS Engine.

Camera(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Camera theCamera = (Camera) obj;

Method Summary

boolean	canSeeMBB(IEnvelope pExtent) Indicates if the camera can see any portion of the given extent.
boolean	canSeeSphere(IPoint pCenter, double radius) Indicates if the camera can see any portion of the given sphere.
boolean	equals(Object o) Compare this object with another
double	getAzimuth() The polar azimuth of the observer relative to the target.
static String	getClsid() getClsid.
int	getDisplayType() Display mode.
double	getEyeSeparation() Eye separation.
int	getEyeType() Eye view.
IRay	getIdentifyRay(int dx, int dy) Returns the ray that corresponds to given screen coordinates.
IVector3D	getIdentifyVector(IPoint pCursor) Returns the vector that corresponds to the given screen location.
double	getInclination() The polar inclination of the observer relative to the target.
int	getLRviewFirst() Left / Right view first.
IPoint	getObserver() The observer's position.
IEnvelope	getOrthoViewingExtent() The extent visible by the camera in orthographic view.
double	getParallax() Parallax.
int	getProjectionType() The type of projection.
double	getRollAngle() The roll angle in degrees.
double	getScale() The orthographic projection scale.
int	getStereoViewType() The type of stereo view.
IPoint	getTarget() The target's position.
IVector3D	getUpDirection() The camera's up-vector.
double	getViewFieldAngle() The view-field angle in degrees.
double	getViewingDistance() The viewing distance between the observer and the target.
int	hashCode() the hashcode for this object
void	hTurnAround(double dAzimuth) Turns the camera horizontally around observer by the given azimuth angle.
boolean	isMultiPhaseRendering() The state of multi-phase rendering.
boolean	isStereoSupported() Indicates if stereo is supported.
boolean	isUsable() Indicates if the camera has valid parameters.
void	levelObsToTarget() Levels the observer to the target.
void	levelTargetToObs() Levels the target to the observer.
void	move(int direction, double factor) Moves the camera in the specified direction.
void	pan(IPoint startPoint, IPoint endPoint) Moves both the observer and the target so that the object picked as the starting point on screen assumes the ending-point position.
void	polarUpdate(double distanceFactor, double dAzimuth, double dInclination, boolean bLimitInclination) Updates the observer's location by given polar increments.
void	propertiesChanged() Sets camera's dirty flag.
void	queryDistanceToMBB(IEnvelope pExtent, double[] distance) Returns the distance to the given extent.
void	queryDistanceToSphere(IPoint pCenter, double radius, double[] distance) Returns the distance to the given sphere.
void	queryDistanceToSphereCenter(IPoint pCenter, double radius, double[] distance) Returns the distance to the given sphere's center.
void	queryIdentifyVector(int dx, int dy, IVector3D pIdentifyVect) Returns the vector that corresponds to given screen coordinates.
void	queryOrthoViewingPlatform(IEnvelope pInExtent, IEnvelope pOutExtent, double[] pScale) Returns orthographic projection viewing parameters corresponding to the given extent.
void	queryViewingPlatformMBB(IEnvelope pExtent, double[] pNearPlane, double[] pFarPlane, double[] pAngle, double[] pAspect) Returns the viewing parameters corresponding to the given extent.
void	queryViewingPlatformSphere(IPoint pCenter, double radius, double[] pNearPlane, double[] pFarPlane, double[] pAngle, double[] pAspect) Returns the viewing parameters corresponding to the given spherical extent.
void	recalcUp() Updates the up-vector.
void	replayFrame(ISceneGraph pSceneGraph) Renders a frame.
void	rotate(double angle) Rotates the observer horizontally around the target by a given angle in degrees.
void	setAzimuth(double azimuth) The polar azimuth of the observer relative to the target.
void	setDefaultsMBB(IEnvelope pExtent) Positions camera so that the entire given extent can be seen.
void	setDefaultsSphere(IPoint pCenter, double radius) Positions camera so that the entire given spherical extent can be seen.
void	setDisplayType(int pType) Display mode.
void	setEyeSeparation(double eyeSeparation) Eye separation.
void	setEyeType(int pType) Eye view.
void	setInclination(double inclination) The polar inclination of the observer relative to the target.
void	setLRviewFirst(int pView) Left / Right view first.
void	setMultiPhaseRendering(boolean pbMultiPhase) The state of multi-phase rendering.
void	setObserver(IPoint observer) The observer's position.
void	setOrthoViewingExtent(IEnvelope rhs1) The extent visible by the camera in orthographic view.
void	setParallax(double pParallax) Parallax.
void	setProjectionType(int projectionType) The type of projection.
void	setRollAngle(double rollAngle) The roll angle in degrees.
void	setStereoViewType(int pType) The type of stereo view.
void	setTarget(IPoint target) The target's position.
void	setUpDirection(IVector3D upVector) The camera's up-vector.
void	setVerticalExaggeration(double rhs1) Adapts the camera to the scene's vertical exaggeration.
void	setViewFieldAngle(double viewFieldAngle) The view-field angle in degrees.
void	setViewingDistance(double distance) The viewing distance between the observer and the target.
void	zoom(double ratio) Zooms in or out by moving the observer according to the required ratio between the new and previous viewing distances.
void	zoomToRect(IEnvelope pExtent) Zooms to the given screen extent.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

Camera

public Camera()
       throws IOException,
              UnknownHostException

Constructs a Camera using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Camera

public Camera(Object obj)
       throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Camera theCamera = (Camera) obj;

Construct a Camera using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Camera.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getObserver

public IPoint getObserver()
                   throws IOException,
                          AutomationException

The observer's position.

Remarks

The observer represents the origin, or point of view, of the camera. It uses coordinates that are in the same unit of measure as the scene itself.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getObserver in interface ICamera

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObserver

public void setObserver(IPoint observer)
                 throws IOException,
                        AutomationException

The observer's position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setObserver in interface ICamera

Parameters:

observer - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTarget

public IPoint getTarget()
                 throws IOException,
                        AutomationException

The target's position.

Remarks

The target is what the observer is looking at, or in other words, what the camera is pointed towards. It uses coordinates that are in the same unit of measure as the scene itself.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTarget in interface ICamera

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTarget

public void setTarget(IPoint target)
               throws IOException,
                      AutomationException

The target's position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTarget in interface ICamera

Parameters:

target - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpDirection

public IVector3D getUpDirection()
                         throws IOException,
                                AutomationException

The camera's up-vector.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUpDirection in interface ICamera

Returns:

A reference to a com.esri.arcgis.geometry.IVector3D

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpDirection

public void setUpDirection(IVector3D upVector)
                    throws IOException,
                           AutomationException

The camera's up-vector.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUpDirection in interface ICamera

Parameters:

upVector - A reference to a com.esri.arcgis.geometry.IVector3D (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewingDistance

public double getViewingDistance()
                          throws IOException,
                                 AutomationException

The viewing distance between the observer and the target. When changing, the observer moves.

Remarks

The ViewingDistance is in the current scene units as defined by the horizontal coordinate system of the scene's spatial reference.

Setting the ViewingDistance will modify the observer's position along the line of sight relative to the target.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getViewingDistance in interface ICamera

Returns:

The distance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setViewingDistance

public void setViewingDistance(double distance)
                        throws IOException,
                               AutomationException

The viewing distance between the observer and the target. When changing, the observer moves.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setViewingDistance in interface ICamera

Parameters:

distance - The distance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewFieldAngle

public double getViewFieldAngle()
                         throws IOException,
                                AutomationException

The view-field angle in degrees.

Remarks

Increasing the ViewFieldAngle creates the appearance of zooming out even though the observer position is unchanged. Wide angles enable the observer to see a large portion of the scene when positioned inside the data area. A wide angle also presents a distorted view, similar to that of a fish-eye lens.

Decreasing the ViewFieldAngle creates the appearance of zooming in even though the observer position is unchanged.

The default ViewFieldAngle is 55 degrees.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getViewFieldAngle in interface ICamera

Returns:

The viewFieldAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setViewFieldAngle

public void setViewFieldAngle(double viewFieldAngle)
                       throws IOException,
                              AutomationException

The view-field angle in degrees.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setViewFieldAngle in interface ICamera

Parameters:

viewFieldAngle - The viewFieldAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRollAngle

public double getRollAngle()
                    throws IOException,
                           AutomationException

The roll angle in degrees.

Remarks

The RollAngle represents the angle, in degrees, of the camera about the line of sight between the observer and target. Angles will be reported in the range >=0 and <360. Angles can be given outside of this range but will be 'wrapped' to the equivalent value in the 0 to 360 range. For example -1 is the equivalent of 359 and 361 is the equivalent of 1.

A RollAngle of 0.0, the default, is straight up relative to the Z axis in the scene. Increasing the RollAngle will tilt the camera clockwise about the line of sight.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRollAngle in interface ICamera

Returns:

The rollAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRollAngle

public void setRollAngle(double rollAngle)
                  throws IOException,
                         AutomationException

The roll angle in degrees.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRollAngle in interface ICamera

Parameters:

rollAngle - The rollAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProjectionType

public int getProjectionType()
                      throws IOException,
                             AutomationException

The type of projection.

Remarks

The projection can be set to either esriPerspectiveProjection or esriOrthoProjection. A perspective projection provides a sense of three dimensionality. An orthographic projection maintains constant scale throughout and is used to provide a 2D, planimetric, view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getProjectionType in interface ICamera

Returns:

A com.esri.arcgis.analyst3d.esri3DProjectionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProjectionType

public void setProjectionType(int projectionType)
                       throws IOException,
                              AutomationException

The type of projection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setProjectionType in interface ICamera

Parameters:

projectionType - A com.esri.arcgis.analyst3d.esri3DProjectionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsable

public boolean isUsable()
                 throws IOException,
                        AutomationException

Indicates if the camera has valid parameters.

Remarks

Before doing something with a camera it is advisable to call IsUsable first. It's possible the camera has some properties which are undefined or is unable to perform certain requests. This happens when a camera is associated with an empty scene, the target/observer or other parameters has invalid values (not a number, for instance), or when the target and the observer share the same location etc.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUsable in interface ICamera

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInclination

public double getInclination()
                      throws IOException,
                             AutomationException

The polar inclination of the observer relative to the target. When changed, the observer moves.

Remarks

The inclination represents the altitude angle, in degrees, of the observer relative to the target. When the observer is above the target the inclination is positive, when below it's negative.

The value given for inclination can be greater than -90 or less than 90. Values outside this range will be reset automatically to the closest positive or negative limit (e.g. 95 reset to 89.9999).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInclination in interface ICamera

Returns:

The inclination

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInclination

public void setInclination(double inclination)
                    throws IOException,
                           AutomationException

The polar inclination of the observer relative to the target. When changed, the observer moves.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInclination in interface ICamera

Parameters:

inclination - The inclination (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAzimuth

public double getAzimuth()
                  throws IOException,
                         AutomationException

The polar azimuth of the observer relative to the target. When changed, the observer moves.

Remarks

The azimuth represents the compass direction, in degrees, of the observer relative to the target. At 0 degrees the observer is due north of the target, 90 degrees due east, 180 degrees due south, and 270 degrees due west.

Values exceeding the range 0-360 will be reset to the equivalent value that falls in this range (e.g. 365 gets reset to 5, -5 gets reset to 355).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAzimuth in interface ICamera

Returns:

The azimuth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAzimuth

public void setAzimuth(double azimuth)
                throws IOException,
                       AutomationException

The polar azimuth of the observer relative to the target. When changed, the observer moves.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAzimuth in interface ICamera

Parameters:

azimuth - The azimuth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotate

public void rotate(double angle)
            throws IOException,
                   AutomationException

Rotates the observer horizontally around the target by a given angle in degrees.

Remarks

Positive values for degrees will rotate the observer clockwise around the target, negative values counter-clockwise.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

rotate in interface ICamera

Parameters:

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

polarUpdate

public void polarUpdate(double distanceFactor,
                        double dAzimuth,
                        double dInclination,
                        boolean bLimitInclination)
                 throws IOException,
                        AutomationException

Updates the observer's location by given polar increments.

Remarks

The observer will be moved by the values specified in the arguments:

The distanceFactor resets the current ViewingDistance (distance between observer and target) by multiplying it by the given factor.

dAzimuth is added to the current azimuth.

dInclination is added to the current inclination. If the resulting inclination doesn't fall between -89.9 and 89.9 it will be reset so that it does unless bLimitInclination is set to False.

bLimitInclination when set to True ensures the modified inclination doesn't fall outside the -89.9 to 89.9 limit. If set to False and the limit is exceeded the azimuth will be changed 180 degrees and the UpDirection will be flipped.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

polarUpdate in interface ICamera

Parameters:

distanceFactor - The distanceFactor (in)

dAzimuth - The dAzimuth (in)

dInclination - The dInclination (in)

bLimitInclination - The bLimitInclination (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

recalcUp

public void recalcUp()
              throws IOException,
                     AutomationException

Updates the up-vector.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

recalcUp in interface ICamera

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

propertiesChanged

public void propertiesChanged()
                       throws IOException,
                              AutomationException

Sets camera's dirty flag.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

propertiesChanged in interface ICamera

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultsMBB

public void setDefaultsMBB(IEnvelope pExtent)
                    throws IOException,
                           AutomationException

Positions camera so that the entire given extent can be seen.

Remarks

The SetDefaultsMBB method of the camera object in a 3D scene can be used to programmatically zoom to a designated extent of 'minimum bounding box'.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultsMBB in interface ICamera

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultsSphere

public void setDefaultsSphere(IPoint pCenter,
                              double radius)
                       throws IOException,
                              AutomationException

Positions camera so that the entire given spherical extent can be seen.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultsSphere in interface ICamera

Parameters:

pCenter - A reference to a com.esri.arcgis.geometry.IPoint (in)

radius - The radius (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryViewingPlatformMBB

public void queryViewingPlatformMBB(IEnvelope pExtent,
                                    double[] pNearPlane,
                                    double[] pFarPlane,
                                    double[] pAngle,
                                    double[] pAspect)
                             throws IOException,
                                    AutomationException

Returns the viewing parameters corresponding to the given extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryViewingPlatformMBB in interface ICamera

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pNearPlane - The pNearPlane (out: use single element array)

pFarPlane - The pFarPlane (out: use single element array)

pAngle - The pAngle (out: use single element array)

pAspect - The pAspect (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryViewingPlatformSphere

public void queryViewingPlatformSphere(IPoint pCenter,
                                       double radius,
                                       double[] pNearPlane,
                                       double[] pFarPlane,
                                       double[] pAngle,
                                       double[] pAspect)
                                throws IOException,
                                       AutomationException

Returns the viewing parameters corresponding to the given spherical extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryViewingPlatformSphere in interface ICamera

Parameters:

pCenter - A reference to a com.esri.arcgis.geometry.IPoint (in)

radius - The radius (in)

pNearPlane - The pNearPlane (out: use single element array)

pFarPlane - The pFarPlane (out: use single element array)

pAngle - The pAngle (out: use single element array)

pAspect - The pAspect (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryOrthoViewingPlatform

public void queryOrthoViewingPlatform(IEnvelope pInExtent,
                                      IEnvelope pOutExtent,
                                      double[] pScale)
                               throws IOException,
                                      AutomationException

Returns orthographic projection viewing parameters corresponding to the given extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryOrthoViewingPlatform in interface ICamera

Parameters:

pInExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pOutExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pScale - The pScale (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrthoViewingExtent

public IEnvelope getOrthoViewingExtent()
                                throws IOException,
                                       AutomationException

The extent visible by the camera in orthographic view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOrthoViewingExtent in interface ICamera

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replayFrame

public void replayFrame(ISceneGraph pSceneGraph)
                 throws IOException,
                        AutomationException

Renders a frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

replayFrame in interface ICamera

Parameters:

pSceneGraph - A reference to a com.esri.arcgis.analyst3d.ISceneGraph (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSeeMBB

public boolean canSeeMBB(IEnvelope pExtent)
                  throws IOException,
                         AutomationException

Indicates if the camera can see any portion of the given extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

canSeeMBB in interface ICamera

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Returns:

The canSee

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSeeSphere

public boolean canSeeSphere(IPoint pCenter,
                            double radius)
                     throws IOException,
                            AutomationException

Indicates if the camera can see any portion of the given sphere.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

canSeeSphere in interface ICamera

Parameters:

pCenter - A reference to a com.esri.arcgis.geometry.IPoint (in)

radius - The radius (in)

Returns:

The canSee

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDistanceToMBB

public void queryDistanceToMBB(IEnvelope pExtent,
                               double[] distance)
                        throws IOException,
                               AutomationException

Returns the distance to the given extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryDistanceToMBB in interface ICamera

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

distance - The distance (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDistanceToSphere

public void queryDistanceToSphere(IPoint pCenter,
                                  double radius,
                                  double[] distance)
                           throws IOException,
                                  AutomationException

Returns the distance to the given sphere.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryDistanceToSphere in interface ICamera

Parameters:

pCenter - A reference to a com.esri.arcgis.geometry.IPoint (in)

radius - The radius (in)

distance - The distance (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDistanceToSphereCenter

public void queryDistanceToSphereCenter(IPoint pCenter,
                                        double radius,
                                        double[] distance)
                                 throws IOException,
                                        AutomationException

Returns the distance to the given sphere's center.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryDistanceToSphereCenter in interface ICamera

Parameters:

pCenter - A reference to a com.esri.arcgis.geometry.IPoint (in)

radius - The radius (in)

distance - The distance (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryIdentifyVector

public void queryIdentifyVector(int dx,
                                int dy,
                                IVector3D pIdentifyVect)
                         throws IOException,
                                AutomationException

Returns the vector that corresponds to given screen coordinates.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryIdentifyVector in interface ICamera

Parameters:

dx - The dx (in)

dy - The dy (in)

pIdentifyVect - A reference to a com.esri.arcgis.geometry.IVector3D (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifyVector

public IVector3D getIdentifyVector(IPoint pCursor)
                            throws IOException,
                                   AutomationException

Returns the vector that corresponds to the given screen location.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIdentifyVector in interface ICamera

Parameters:

pCursor - A reference to a com.esri.arcgis.geometry.IPoint (in)

Returns:

A reference to a com.esri.arcgis.geometry.IVector3D

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifyRay

public IRay getIdentifyRay(int dx,
                           int dy)
                    throws IOException,
                           AutomationException

Returns the ray that corresponds to given screen coordinates.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIdentifyRay in interface ICamera

Parameters:

dx - The dx (in)

dy - The dy (in)

Returns:

A reference to a com.esri.arcgis.geometry.IRay

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

public void move(int direction,
                 double factor)
          throws IOException,
                 AutomationException

Moves the camera in the specified direction. The distance is calculated by applying the given factor to the current viewing distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

move in interface ICamera

Parameters:

direction - A com.esri.arcgis.analyst3d.esriCameraMovementType constant (in)

factor - The factor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pan

public void pan(IPoint startPoint,
                IPoint endPoint)
         throws IOException,
                AutomationException

Moves both the observer and the target so that the object picked as the starting point on screen assumes the ending-point position.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

pan in interface ICamera

Parameters:

startPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

endPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

levelTargetToObs

public void levelTargetToObs()
                      throws IOException,
                             AutomationException

Levels the target to the observer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

levelTargetToObs in interface ICamera

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

levelObsToTarget

public void levelObsToTarget()
                      throws IOException,
                             AutomationException

Levels the observer to the target.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

levelObsToTarget in interface ICamera

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hTurnAround

public void hTurnAround(double dAzimuth)
                 throws IOException,
                        AutomationException

Turns the camera horizontally around observer by the given azimuth angle.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

hTurnAround in interface ICamera

Parameters:

dAzimuth - The dAzimuth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoom

public void zoom(double ratio)
          throws IOException,
                 AutomationException

Zooms in or out by moving the observer according to the required ratio between the new and previous viewing distances.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

zoom in interface ICamera

Parameters:

ratio - The ratio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomToRect

public void zoomToRect(IEnvelope pExtent)
                throws IOException,
                       AutomationException

Zooms to the given screen extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

zoomToRect in interface ICamera

Parameters:

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScale

public double getScale()
                throws IOException,
                       AutomationException

The orthographic projection scale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getScale in interface ICamera

Returns:

The pScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMultiPhaseRendering

public void setMultiPhaseRendering(boolean pbMultiPhase)
                            throws IOException,
                                   AutomationException

The state of multi-phase rendering. When true, the scene depth can be divided into multiple passes to improve rendering quality.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMultiPhaseRendering in interface ICamera

Parameters:

pbMultiPhase - The pbMultiPhase (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMultiPhaseRendering

public boolean isMultiPhaseRendering()
                              throws IOException,
                                     AutomationException

The state of multi-phase rendering. When true, the scene depth can be divided into multiple passes to improve rendering quality.

Remarks

MultiPhaseRendering is only implemented in ArcScene. When set to True (the default is False), multiple drawing steps are enabled to avoid Z-buffer imprecisions when the ratio of far/near distance is too large, therefore layers with extreme extents may be seen throughout the scene. The far/near distance here refers to the distance between the observer and the far/near clipping plane in OpenGL terms.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMultiPhaseRendering in interface ICamera

Returns:

The pbMultiPhase

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalExaggeration

public void setVerticalExaggeration(double rhs1)
                             throws IOException,
                                    AutomationException

Adapts the camera to the scene's vertical exaggeration.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVerticalExaggeration in interface ICamera

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayType

public int getDisplayType()
                   throws IOException,
                          AutomationException

Display mode.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDisplayType in interface ICamera2

Returns:

A com.esri.arcgis.analyst3d.esriDisplayType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayType

public void setDisplayType(int pType)
                    throws IOException,
                           AutomationException

Display mode.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayType in interface ICamera2

Parameters:

pType - A com.esri.arcgis.analyst3d.esriDisplayType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrthoViewingExtent

public void setOrthoViewingExtent(IEnvelope rhs1)
                           throws IOException,
                                  AutomationException

The extent visible by the camera in orthographic view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:

setOrthoViewingExtent in interface ICamera3

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEyeType

public int getEyeType()
               throws IOException,
                      AutomationException

Eye view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEyeType in interface IStereoCamera

Returns:

A com.esri.arcgis.analyst3d.esriEyeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEyeType

public void setEyeType(int pType)
                throws IOException,
                       AutomationException

Eye view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEyeType in interface IStereoCamera

Parameters:

pType - A com.esri.arcgis.analyst3d.esriEyeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStereoViewType

public int getStereoViewType()
                      throws IOException,
                             AutomationException

The type of stereo view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStereoViewType in interface IStereoCamera

Returns:

A com.esri.arcgis.analyst3d.esriStereoViewType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStereoViewType

public void setStereoViewType(int pType)
                       throws IOException,
                              AutomationException

The type of stereo view.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStereoViewType in interface IStereoCamera

Parameters:

pType - A com.esri.arcgis.analyst3d.esriStereoViewType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEyeSeparation

public double getEyeSeparation()
                        throws IOException,
                               AutomationException

Eye separation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEyeSeparation in interface IStereoCamera

Returns:

The eyeSeparation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEyeSeparation

public void setEyeSeparation(double eyeSeparation)
                      throws IOException,
                             AutomationException

Eye separation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEyeSeparation in interface IStereoCamera

Parameters:

eyeSeparation - The eyeSeparation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParallax

public double getParallax()
                   throws IOException,
                          AutomationException

Parallax.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getParallax in interface IStereoCamera

Returns:

The pParallax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParallax

public void setParallax(double pParallax)
                 throws IOException,
                        AutomationException

Parallax.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setParallax in interface IStereoCamera

Parameters:

pParallax - The pParallax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLRviewFirst

public int getLRviewFirst()
                   throws IOException,
                          AutomationException

Left / Right view first.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLRviewFirst in interface IStereoCamera

Returns:

A com.esri.arcgis.analyst3d.esriEyeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLRviewFirst

public void setLRviewFirst(int pView)
                    throws IOException,
                           AutomationException

Left / Right view first.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLRviewFirst in interface IStereoCamera

Parameters:

pView - A com.esri.arcgis.analyst3d.esriEyeType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStereoSupported

public boolean isStereoSupported()
                          throws IOException,
                                 AutomationException

Indicates if stereo is supported.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isStereoSupported in interface IStereoCamera

Returns:

The pbStereo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.