com.esri.arcgis.analyst3d
Interface ISceneRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISceneRendererProxy

public interface ISceneRenderer
extends Serializable

Provides access to members that control scene rendering.

Product Availability

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

Method Summary

IEnvelope	getAccumulatedExtent() The accumulated extent after recording an act.
I3DProperties	getDddProperties() The 3D properties.
Object	getRepresents() The object an act represents.
boolean	isCallRecording() Indicates if the scene requires a new recording event.
void	locate(int hint, IRay pQueryRay, boolean bGetTransformed, Object pGeoNode, IPoint[] ppPoint, Object[] ppObject) Locates an object given a hint, ray, and geometry node hit.
void	queryAccumulatedExtent(IEnvelope pExtent) Queries the accumulated extent after recording an act.
void	record(IDisplay3D pDisplay, Object pGeoNode, ITrackCancel pTrackCancel) Records a dataset.
void	setCallRecording(boolean pbCallFlag) Indicates if the scene requires a new recording event.
void	setDddPropertiesByRef(I3DProperties ppFilter) The 3D properties.
void	setRepresentsByRef(Object ppObject) The object an act represents.
void	startRecording(boolean bImmediateMode) Start recording a dataset.

Method Detail

isCallRecording

boolean isCallRecording()
                        throws IOException,
                               AutomationException

Indicates if the scene requires a new recording event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pbCallFlag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCallRecording

void setCallRecording(boolean pbCallFlag)
                      throws IOException,
                             AutomationException

Indicates if the scene requires a new recording event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pbCallFlag - The pbCallFlag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startRecording

void startRecording(boolean bImmediateMode)
                    throws IOException,
                           AutomationException

Start recording a dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bImmediateMode - The bImmediateMode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

record

void record(IDisplay3D pDisplay,
            Object pGeoNode,
            ITrackCancel pTrackCancel)
            throws IOException,
                   AutomationException

Records a dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay3D (in)

pGeoNode - A reference to another Object (IUnknown) (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDddProperties

I3DProperties getDddProperties()
                               throws IOException,
                                      AutomationException

The 3D properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.analyst3d.I3DProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDddPropertiesByRef

void setDddPropertiesByRef(I3DProperties ppFilter)
                           throws IOException,
                                  AutomationException

The 3D properties.

Product Availability

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

Parameters:

ppFilter - A reference to a com.esri.arcgis.analyst3d.I3DProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locate

void locate(int hint,
            IRay pQueryRay,
            boolean bGetTransformed,
            Object pGeoNode,
            IPoint[] ppPoint,
            Object[] ppObject)
            throws IOException,
                   AutomationException

Locates an object given a hint, ray, and geometry node hit.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

hint - The hint (in)

pQueryRay - A reference to a com.esri.arcgis.geometry.IRay (in)

bGetTransformed - The bGetTransformed (in)

pGeoNode - A reference to another Object (IUnknown) (in)

ppPoint - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)

ppObject - A reference to another Object (IUnknown) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRepresentsByRef

void setRepresentsByRef(Object ppObject)
                        throws IOException,
                               AutomationException

The object an act represents.

Product Availability

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

Parameters:

ppObject - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRepresents

Object getRepresents()
                     throws IOException,
                            AutomationException

The object an act represents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccumulatedExtent

IEnvelope getAccumulatedExtent()
                               throws IOException,
                                      AutomationException

The accumulated extent after recording an act.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

queryAccumulatedExtent

void queryAccumulatedExtent(IEnvelope pExtent)
                            throws IOException,
                                   AutomationException

Queries the accumulated extent after recording an act.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.