com.esri.arcgis.analyst3d
Interface ICharacterMarker3DSymbol

All Superinterfaces:
IMarkerSymbol, Serializable
All Known Implementing Classes:
CharacterMarker3DSymbol

public interface ICharacterMarker3DSymbol
extends IMarkerSymbol, Serializable

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

Description

ICharacterMarker3DSymbol can be used to create a 3D marker symbol that uses the TrueType fonts or OpenType fonts. You can set/get the Font and CharacterIndex properties to control the font and glyph used. The VerticalOrientation property allows you to set/get the vertical orientation of the 3D character marker symbol.

Use the IMarker3DPlacement interface to set additional properties for ICharacterMarker3DSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getCharacterIndex()
          Character index within font.
 Font getFont()
          Font used for character symbol.
 boolean isVerticalOrientation()
          Indicates whether character is oriented vertically.
 void setCharacterIndex(int charIndex)
          Character index within font.
 void setFont(Font fontDisp)
          Font used for character symbol.
 void setVerticalOrientation(boolean bVertical)
          Indicates whether character is oriented vertically.
 
Methods inherited from interface com.esri.arcgis.display.IMarkerSymbol
getAngle, getColor, getSize, getXOffset, getYOffset, setAngle, setColor, setSize, setXOffset, setYOffset
 

Method Detail

getFont

Font getFont()
             throws IOException,
                    AutomationException
Font used for character symbol.

Description

Font is the font object (IFontDisp with a StdFont coClass) used by an ICharacterMarker3DSymbol.

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.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFont

void setFont(Font fontDisp)
             throws IOException,
                    AutomationException
Font used for character symbol.

Description

Font is the font object (IFontDisp with a StdFont coClass) used by an ICharacterMarker3DSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCharacterIndex

int getCharacterIndex()
                      throws IOException,
                             AutomationException
Character index within font.

Description

CharacterIndex is the index of the character that an ICharacterMarker3DSymbol uses in the Font that has been specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCharacterIndex

void setCharacterIndex(int charIndex)
                       throws IOException,
                              AutomationException
Character index within font.

Description

CharacterIndex is the index of the character that an ICharacterMarker3DSymbol uses in the Font that has been specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isVerticalOrientation

boolean isVerticalOrientation()
                              throws IOException,
                                     AutomationException
Indicates whether character is oriented vertically.

Description

VerticalOrientation indicates whether the character that an ICharacterMarker3DSymbol uses is oriented vertically.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setVerticalOrientation

void setVerticalOrientation(boolean bVertical)
                            throws IOException,
                                   AutomationException
Indicates whether character is oriented vertically.

Description

VerticalOrientation indicates whether the character that an ICharacterMarker3DSymbol uses is oriented vertically.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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