com.esri.arcgis.carto
Interface ITinRenderer

All Superinterfaces:
Serializable
All Known Subinterfaces:
ITerrainRenderer
All Known Implementing Classes:
TerrainDirtyAreaRenderer, TinAspectRenderer, TinBreaklineRenderer, TinEdgeRenderer, TinElevationRenderer, TinFaceRenderer, TinFaceValueRenderer, TinNodeElevationRenderer, TinNodeRenderer, TinNodeValueRenderer, TinSlopeRenderer

public interface ITinRenderer
extends Serializable

Provides access to members that control functions common to all TIN renderers.

Remarks

This interface is implemented by all ten TIN renderers at ArcGIS 9.0. It provides the basic info for a specific TIN renderer. The following sample VBA code shows a way to query a TIN renderer's name and visibility properties in ArcMap:

Sub ShowTinRenderer()
Dim pDoc As IMxDocument: Set pDoc = ThisDocument
Dim pMap As IMap: Set pMap = pDoc.Maps.Item(0) 'assuming we're working on the first map
Dim pTinLyr As ITinLayer: Set pTinLyr = pMap.Layer(0) 'assuming the first layer is a TIN layer

Dim i As Integer
For i = 0 To pTinLyr.RendererCount - 1
Dim pTinRenderer As ITinRenderer
Set pTinRenderer = pTinLyr.GetRenderer(i)
Debug.Print pTinRenderer.Name, pTinRenderer.Visible
Next i
End Sub

A TIN layer can have one of more TIN renderers. When you load a TIN dataset into an application, two default TIN renderers are added. Depending on applications, the two default TIN renderers vary. In ArcMap, the two default TIN renderers are Edge Type and Elevation renderers. In ArcScene, they're Edge Type and Faces.

The order of TIN renderers in the application has an effect on how the TIN is drawn. In ArcMap, the effect is the same as that in the the TOC in general; higher ones get drawn on top of the lower ones. In ArcScene, rendering conflict may arise if multiple renderers are drawn simultaneously (especially with face renderers) and that should be avoided.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean canRender()
          Indicates if renderer can draw.
 void copy(ITinRenderer pSource)
          Copies the properties of the given renderer.
 void draw(int drawPhase, IDisplay display, ISpatialReference aSpatialReference, ITrackCancel trackCancel)
          Draws the TIN.
 String getName()
          The descriptive name of a renderer.
 ITin getTin()
          The TIN associated with the renderer.
 boolean isVisible()
          Indicates if the renderer is currently visible.
 void setName(String name)
          The descriptive name of a renderer.
 void setTinByRef(ITin ppTin)
          The TIN associated with the renderer.
 void setVisible(boolean visible)
          Indicates if the renderer is currently visible.
 

Method Detail

draw

void draw(int drawPhase,
          IDisplay display,
          ISpatialReference aSpatialReference,
          ITrackCancel trackCancel)
          throws IOException,
                 AutomationException
Draws the TIN.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
aSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
trackCancel - 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.

copy

void copy(ITinRenderer pSource)
          throws IOException,
                 AutomationException
Copies the properties of the given renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pSource - A reference to a com.esri.arcgis.carto.ITinRenderer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRender

boolean canRender()
                  throws IOException,
                         AutomationException
Indicates if renderer can draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCanRender
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTinByRef

void setTinByRef(ITin ppTin)
                 throws IOException,
                        AutomationException
The TIN associated with the renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppTin - A reference to a com.esri.arcgis.geodatabase.ITin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTin

ITin getTin()
            throws IOException,
                   AutomationException
The TIN associated with the renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
The descriptive name of a renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException
The descriptive name of a renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if the renderer is currently visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean visible)
                throws IOException,
                       AutomationException
Indicates if the renderer is currently visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.