com.esri.arcgis.analyst3d
Interface IMarker3DSymbol

All Superinterfaces:
Serializable
All Known Implementing Classes:
Marker3DSymbol

public interface IMarker3DSymbol
extends Serializable

Provides access to members that control the 3D marker symbol.

Description

The IMarker3DSymbol interface provides properties and methods to define 3D marker symbols. The CreateFromFile method enbles import of existing OpenFlight (.flt), 3ds max* (.3ds), or Virtual Reality Markup Language (VRML*) models and then symbolize point features with these models. RestrictAccessToShape restricts the access to the geometry of a 3D marker symbol. IsRestrictedAccess indicates whether the geometry of the 3D Marker Symbol is restricted. UseMaterialDraping is used to display the symbols with or without texture materials.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void createFromFile(String fileName)
          Imports the symbol definition.
 int getMaterialCount()
          Number of materials present.
 IGeometry getShape()
          Marker shape geometry.
 IPicture getThumbnail()
          The symbol thumbnail for 2D representation.
 boolean isRestricted()
          Indicates if the marker restricts access to internal shape.
 boolean isUseMaterialDraping()
          Indicates if the marker uses material property for draping.
 void restrictAccessToShape()
          Restricts all further access to internal shape.
 void setShapeByRef(IGeometry shape)
          Marker shape geometry.
 void setThumbnailByRef(IPicture thumbnail)
          The symbol thumbnail for 2D representation.
 void setUseMaterialDraping(boolean useDraping)
          Indicates if the marker uses material property for draping.
 

Method Detail

setShapeByRef

void setShapeByRef(IGeometry shape)
                   throws IOException,
                          AutomationException
Marker shape geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getShape

IGeometry getShape()
                   throws IOException,
                          AutomationException
Marker shape geometry.

Product Availability

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

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

isUseMaterialDraping

boolean isUseMaterialDraping()
                             throws IOException,
                                    AutomationException
Indicates if the marker uses material property for draping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseMaterialDraping

void setUseMaterialDraping(boolean useDraping)
                           throws IOException,
                                  AutomationException
Indicates if the marker uses material property for draping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaterialCount

int getMaterialCount()
                     throws IOException,
                            AutomationException
Number of materials present.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

createFromFile

void createFromFile(String fileName)
                    throws IOException,
                           AutomationException
Imports the symbol definition.

Description

Pass in the full path to the file. URLs are also supported as the file path string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getThumbnail

IPicture getThumbnail()
                      throws IOException,
                             AutomationException
The symbol thumbnail for 2D representation.

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.support.ms.stdole.IPicture
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThumbnailByRef

void setThumbnailByRef(IPicture thumbnail)
                       throws IOException,
                              AutomationException
The symbol thumbnail for 2D representation.

Product Availability

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

Parameters:
thumbnail - A reference to a com.esri.arcgis.support.ms.stdole.IPicture (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restrictAccessToShape

void restrictAccessToShape()
                           throws IOException,
                                  AutomationException
Restricts all further access to internal shape.

Remarks

Once a marker 3D symbol's shape/geometry is set to be restricted, its geometry cannot be obtained via ArcObjects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isRestricted

boolean isRestricted()
                     throws IOException,
                            AutomationException
Indicates if the marker restricts access to internal shape.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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