com.esri.arcgis.analyst3d
Interface ICamera

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ICamera2, ICamera3

All Known Implementing Classes:

Camera, GlobeCamera, ICamera2Proxy, ICamera3Proxy, ICameraProxy

public interface ICamera
extends java.io.Serializable

COM Interface 'ICamera'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esri3DAnalyst.olb'

Description: 'Provides access to members that manipulate the camera.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDb3fa596f_ada3_11d2_9fae_00c04f8ece3d
static int	xxDummy Deprecated. Internal use only

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.
double	getAzimuth() The polar azimuth of the observer relative to the target.
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.
IPoint	getObserver() The observer's position.
IEnvelope	getOrthoViewingExtent() The extent visible by the camera in orthographic view.
int	getProjectionType() The type of projection.
double	getRollAngle() The roll angle in degrees.
double	getScale() The orthographic projection scale.
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.
void	hTurnAround(double dAzimuth) Turns the camera horizontally around observer by the given azimuth angle.
boolean	isMultiPhaseRendering() The state of multi-phase rendering.
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	setInclination(double inclination) The polar inclination of the observer relative to the target.
void	setMultiPhaseRendering(boolean pbMultiPhase) The state of multi-phase rendering.
void	setObserver(IPoint observer) The observer's position.
void	setProjectionType(int projectionType) The type of projection.
void	setRollAngle(double rollAngle) The roll angle in degrees.
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.

Field Detail

IIDb3fa596f_ada3_11d2_9fae_00c04f8ece3d

static final int IIDb3fa596f_ada3_11d2_9fae_00c04f8ece3d

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getObserver

IPoint getObserver()
                   throws java.io.IOException,
                          AutomationException

The observer's position.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObserver

void setObserver(IPoint observer)
                 throws java.io.IOException,
                        AutomationException

The observer's position.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTarget

IPoint getTarget()
                 throws java.io.IOException,
                        AutomationException

The target's position.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTarget

void setTarget(IPoint target)
               throws java.io.IOException,
                      AutomationException

The target's position.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpDirection

IVector3D getUpDirection()
                         throws java.io.IOException,
                                AutomationException

The camera's up-vector.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpDirection

void setUpDirection(IVector3D upVector)
                    throws java.io.IOException,
                           AutomationException

The camera's up-vector.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewingDistance

double getViewingDistance()
                          throws java.io.IOException,
                                 AutomationException

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

Returns:

The distance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setViewingDistance

void setViewingDistance(double distance)
                        throws java.io.IOException,
                               AutomationException

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

Parameters:

distance - The distance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getViewFieldAngle

double getViewFieldAngle()
                         throws java.io.IOException,
                                AutomationException

The view-field angle in degrees.

Returns:

The viewFieldAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setViewFieldAngle

void setViewFieldAngle(double viewFieldAngle)
                       throws java.io.IOException,
                              AutomationException

The view-field angle in degrees.

Parameters:

viewFieldAngle - The viewFieldAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRollAngle

double getRollAngle()
                    throws java.io.IOException,
                           AutomationException

The roll angle in degrees.

Returns:

The rollAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRollAngle

void setRollAngle(double rollAngle)
                  throws java.io.IOException,
                         AutomationException

The roll angle in degrees.

Parameters:

rollAngle - The rollAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProjectionType

int getProjectionType()
                      throws java.io.IOException,
                             AutomationException

The type of projection.

Returns:

A com.esri.arcgis.analyst3d.esri3DProjectionType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProjectionType

void setProjectionType(int projectionType)
                       throws java.io.IOException,
                              AutomationException

The type of projection.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsable

boolean isUsable()
                 throws java.io.IOException,
                        AutomationException

Indicates if the camera has valid parameters.

Returns:

The isValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInclination

double getInclination()
                      throws java.io.IOException,
                             AutomationException

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

Returns:

The inclination

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInclination

void setInclination(double inclination)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

inclination - The inclination (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAzimuth

double getAzimuth()
                  throws java.io.IOException,
                         AutomationException

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

Returns:

The azimuth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAzimuth

void setAzimuth(double azimuth)
                throws java.io.IOException,
                       AutomationException

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

Parameters:

azimuth - The azimuth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rotate

void rotate(double angle)
            throws java.io.IOException,
                   AutomationException

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

Parameters:

angle - The angle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

polarUpdate

void polarUpdate(double distanceFactor,
                 double dAzimuth,
                 double dInclination,
                 boolean bLimitInclination)
                 throws java.io.IOException,
                        AutomationException

Updates the observer's location by given polar increments.

Parameters:

distanceFactor - The distanceFactor (in)

dAzimuth - The dAzimuth (in)

dInclination - The dInclination (in)

bLimitInclination - The bLimitInclination (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

recalcUp

void recalcUp()
              throws java.io.IOException,
                     AutomationException

Updates the up-vector.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

propertiesChanged

void propertiesChanged()
                       throws java.io.IOException,
                              AutomationException

Sets camera's dirty flag.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultsMBB

void setDefaultsMBB(IEnvelope pExtent)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultsSphere

void setDefaultsSphere(IPoint pCenter,
                       double radius)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

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

radius - The radius (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryViewingPlatformMBB

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

Returns the viewing parameters corresponding to the given extent.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryViewingPlatformSphere

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

Returns the viewing parameters corresponding to the given spherical extent.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryOrthoViewingPlatform

void queryOrthoViewingPlatform(IEnvelope pInExtent,
                               IEnvelope pOutExtent,
                               double[] pScale)
                               throws java.io.IOException,
                                      AutomationException

Returns orthographic projection viewing parameters corresponding to the given extent.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrthoViewingExtent

IEnvelope getOrthoViewingExtent()
                                throws java.io.IOException,
                                       AutomationException

The extent visible by the camera in orthographic view.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replayFrame

void replayFrame(ISceneGraph pSceneGraph)
                 throws java.io.IOException,
                        AutomationException

Renders a frame.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSeeMBB

boolean canSeeMBB(IEnvelope pExtent)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

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

Returns:

The canSee

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canSeeSphere

boolean canSeeSphere(IPoint pCenter,
                     double radius)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

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

radius - The radius (in)

Returns:

The canSee

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDistanceToMBB

void queryDistanceToMBB(IEnvelope pExtent,
                        double[] distance)
                        throws java.io.IOException,
                               AutomationException

Returns the distance to the given extent.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDistanceToSphere

void queryDistanceToSphere(IPoint pCenter,
                           double radius,
                           double[] distance)
                           throws java.io.IOException,
                                  AutomationException

Returns the distance to the given sphere.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryDistanceToSphereCenter

void queryDistanceToSphereCenter(IPoint pCenter,
                                 double radius,
                                 double[] distance)
                                 throws java.io.IOException,
                                        AutomationException

Returns the distance to the given sphere's center.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryIdentifyVector

void queryIdentifyVector(int dx,
                         int dy,
                         IVector3D pIdentifyVect)
                         throws java.io.IOException,
                                AutomationException

Returns the vector that corresponds to given screen coordinates.

Parameters:

dx - The dx (in)

dy - The dy (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifyVector

IVector3D getIdentifyVector(IPoint pCursor)
                            throws java.io.IOException,
                                   AutomationException

Returns the vector that corresponds to the given screen location.

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifyRay

IRay getIdentifyRay(int dx,
                    int dy)
                    throws java.io.IOException,
                           AutomationException

Returns the ray that corresponds to given screen coordinates.

Parameters:

dx - The dx (in)

dy - The dy (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

void move(int direction,
          double factor)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

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

factor - The factor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pan

void pan(IPoint startPoint,
         IPoint endPoint)
         throws java.io.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.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

levelTargetToObs

void levelTargetToObs()
                      throws java.io.IOException,
                             AutomationException

Levels the target to the observer.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

levelObsToTarget

void levelObsToTarget()
                      throws java.io.IOException,
                             AutomationException

Levels the observer to the target.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hTurnAround

void hTurnAround(double dAzimuth)
                 throws java.io.IOException,
                        AutomationException

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

Parameters:

dAzimuth - The dAzimuth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoom

void zoom(double ratio)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

ratio - The ratio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomToRect

void zoomToRect(IEnvelope pExtent)
                throws java.io.IOException,
                       AutomationException

Zooms to the given screen extent.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScale

double getScale()
                throws java.io.IOException,
                       AutomationException

The orthographic projection scale.

Returns:

The pScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMultiPhaseRendering

void setMultiPhaseRendering(boolean pbMultiPhase)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

pbMultiPhase - The pbMultiPhase (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMultiPhaseRendering

boolean isMultiPhaseRendering()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

The pbMultiPhase

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalExaggeration

void setVerticalExaggeration(double rhs1)
                             throws java.io.IOException,
                                    AutomationException

Adapts the camera to the scene's vertical exaggeration.

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.