com.esri.arcgis.analyst3d.Marker3DSymbol
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class Marker3DSymbol
3D Marker Symbol component.
Use the Marker3DSymbol coclass to symboloize point data with 3D marker symbols. The Marker3DSymbol determines the style and properties of a 3D marker symbol, whose geometry can be imported by using Import3DFile coclass from existing OpenFlight (*.flt), 3DS (*.3ds), or Virtual Reality Markup Language (VRML 2.0, *.wrl) models at ArcGIS 9.0.
| Constructor Summary | |
|---|---|
Marker3DSymbol()
Constructs a Marker3DSymbol using ArcGIS Engine. |
|
Marker3DSymbol(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Marker3DSymbol theMarker3DSymbol = (Marker3DSymbol) obj; |
|
| Method Summary | |
|---|---|
boolean |
applies(Object pUnk)
Indicates if the receiver can apply the given object at any given time. |
Object |
apply(Object newObject)
Applies the given property to the receiver and returns the old object. |
void |
applyToPoint(IPoint inShape,
IGeometry[] outShape,
double enforcedZ,
double unitFactor,
double zScale)
Applies symbol construction to original shape. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
boolean |
canApply(Object pUnk)
Indicates if the receiver can apply the given object at that particular moment. |
void |
createFromFile(String fileName)
Imports the symbol definition. |
void |
draw(IGeometry geometry)
Draws the specified shape. |
boolean |
equals(Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
double |
getAngle()
Marker symbol angle. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
IColor |
getColor()
Marker symbol color. |
Object |
getCurrent(Object pUnk)
The object currently being used. |
double |
getDepth()
The depth value. |
int |
getMapLevel()
Current map level for drawing multi-level symbols. |
int |
getMaterialCount()
Number of materials present. |
String |
getNameString()
The display name of an object. |
IVector3D |
getNormalizedOriginOffset()
Normalized offset vector defining the origin within the MBB relative to lower-left corner. |
int |
getROP2()
Raster operation code for pixel drawing. |
IGeometry |
getShape()
Marker shape geometry. |
double |
getSize()
Marker symbol size. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
IPicture |
getThumbnail()
The symbol thumbnail for 2D representation. |
int |
getUnits()
The size units. |
double |
getWidth()
The width value. |
double |
getXOffset()
Symbol X-axis offset from point location. |
double |
getYOffset()
Symbol Y-axis offset from point location. |
double |
getZOffset()
The Z offset value. |
int |
hashCode()
the hashcode for this object |
boolean |
isBillboardDisplay()
Indicates whether symbol is billboarded. |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
boolean |
isMaintainAspectRatio()
Indicates if the marker maintains its dimensions based on size. |
boolean |
isRestricted()
Indicates if the marker restricts access to internal shape. |
boolean |
isUseMaterialDraping()
Indicates if the marker uses material property for draping. |
void |
load(IStream pstm)
load |
void |
queryBoundary(int hDC,
ITransformation displayTransform,
IGeometry geometry,
IPolygon boundary)
Fills an existing polygon with the boundary of the specified symbol. |
void |
queryRotationAngles(double[] xAngle,
double[] yAngle,
double[] zAngle)
Gets the rotation angles for each axis. |
void |
readExternal(ObjectInput in)
|
void |
resetDC()
Restores DC to original state. |
void |
restrictAccessToShape()
Restricts all further access to internal shape. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAngle(double angle)
Marker symbol angle. |
void |
setBillboardDisplay(boolean pBillboard)
Indicates whether symbol is billboarded. |
void |
setColor(IColor color)
Marker symbol color. |
void |
setDepth(double depth)
The depth value. |
void |
setMaintainAspectRatio(boolean bAspectRatio)
Indicates if the marker maintains its dimensions based on size. |
void |
setMapLevel(int mapLevel)
Current map level for drawing multi-level symbols. |
void |
setNormalizedOriginOffsetByRef(IVector3D offset)
Normalized offset vector defining the origin within the MBB relative to lower-left corner. |
void |
setROP2(int drawMode)
Raster operation code for pixel drawing. |
void |
setRotationAngles(double xAngle,
double yAngle,
double zAngle)
Sets the rotation angles for each axis. |
void |
setShapeByRef(IGeometry shape)
Marker shape geometry. |
void |
setSize(double size)
Marker symbol size. |
void |
setThumbnailByRef(IPicture thumbnail)
The symbol thumbnail for 2D representation. |
void |
setUnits(int unitsCode)
The size units. |
void |
setupDC(int hDC,
ITransformation transformation)
Prepares the DC for drawing the symbol. |
void |
setUseMaterialDraping(boolean useDraping)
Indicates if the marker uses material property for draping. |
void |
setWidth(double width)
The width value. |
void |
setXOffset(double xOffset)
Symbol X-axis offset from point location. |
void |
setYOffset(double yOffset)
Symbol Y-axis offset from point location. |
void |
setZOffset(double zOffset)
The Z offset value. |
void |
writeExternal(ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public Marker3DSymbol()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public Marker3DSymbol(Object obj)
throws IOException
Marker3DSymbol theMarker3DSymbol = (Marker3DSymbol) obj;
obj to Marker3DSymbol.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void setShapeByRef(IGeometry shape)
throws IOException,
AutomationException
setShapeByRef in interface IMarker3DSymbolshape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGeometry getShape()
throws IOException,
AutomationException
getShape in interface IMarker3DPlacementgetShape in interface IMarker3DSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseMaterialDraping()
throws IOException,
AutomationException
isUseMaterialDraping in interface IMarker3DSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseMaterialDraping(boolean useDraping)
throws IOException,
AutomationException
setUseMaterialDraping in interface IMarker3DSymboluseDraping - The useDraping (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getMaterialCount()
throws IOException,
AutomationException
getMaterialCount in interface IMarker3DSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void createFromFile(String fileName)
throws IOException,
AutomationException
Pass in the full path to the file. URLs are also supported as the file path string.
createFromFile in interface IMarker3DSymbolfileName - The fileName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPicture getThumbnail()
throws IOException,
AutomationException
getThumbnail in interface IMarker3DSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setThumbnailByRef(IPicture thumbnail)
throws IOException,
AutomationException
setThumbnailByRef in interface IMarker3DSymbolthumbnail - A reference to a com.esri.arcgis.support.ms.stdole.IPicture (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void restrictAccessToShape()
throws IOException,
AutomationException
Once a marker 3D symbol's shape/geometry is set to be restricted, its geometry cannot be obtained via ArcObjects.
restrictAccessToShape in interface IMarker3DSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRestricted()
throws IOException,
AutomationException
isRestricted in interface IMarker3DSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getUnits()
throws IOException,
AutomationException
getUnits in interface IMarker3DPlacementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUnits(int unitsCode)
throws IOException,
AutomationException
setUnits in interface IMarker3DPlacementunitsCode - A com.esri.arcgis.system.esriUnits constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IVector3D getNormalizedOriginOffset()
throws IOException,
AutomationException
getNormalizedOriginOffset in interface IMarker3DPlacementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setNormalizedOriginOffsetByRef(IVector3D offset)
throws IOException,
AutomationException
setNormalizedOriginOffsetByRef in interface IMarker3DPlacementoffset - A reference to a com.esri.arcgis.geometry.IVector3D (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getZOffset()
throws IOException,
AutomationException
getZOffset in interface IMarker3DPlacementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setZOffset(double zOffset)
throws IOException,
AutomationException
setZOffset in interface IMarker3DPlacementzOffset - The zOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void applyToPoint(IPoint inShape,
IGeometry[] outShape,
double enforcedZ,
double unitFactor,
double zScale)
throws IOException,
AutomationException
The ApplyToPoint method is used to apply the 3D Marker symbol to a 3D point, thereby creating a georeferenced geometry for use elsewhere. Essentially, it allows you to generate a geometry using the marker symbol as a template. This can be useful, for example, when creating new features to be stored in the geodatabase. The geometry created is usually a multipatch, though it depends upon the 3D symbol being used.
This interface has been traditionally used for
converting symbolized 2D feature classes into 3D multipatch feature
classes. From 9.2, the Layer 3D to feature class
geoprocessing tool can be used as an alternative.
The parameters of ApplyToPoint are:
This call will fail if the symbol is protected by IMarker3DSymbol.IsRestricted property.
applyToPoint in interface IMarker3DPlacementinShape - A reference to a com.esri.arcgis.geometry.IPoint (in)outShape - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)enforcedZ - The enforcedZ (in, optional, pass -1.1E+38 if not required)unitFactor - The unitFactor (in, optional, pass 0 if not required)zScale - The zScale (in, optional, pass 1 if not required)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryRotationAngles(double[] xAngle,
double[] yAngle,
double[] zAngle)
throws IOException,
AutomationException
queryRotationAngles in interface IMarker3DPlacementxAngle - The xAngle (out: use single element array)yAngle - The yAngle (out: use single element array)zAngle - The zAngle (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRotationAngles(double xAngle,
double yAngle,
double zAngle)
throws IOException,
AutomationException
setRotationAngles in interface IMarker3DPlacementxAngle - The xAngle (in)yAngle - The yAngle (in)zAngle - The zAngle (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getWidth()
throws IOException,
AutomationException
getWidth in interface IMarker3DPlacementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setWidth(double width)
throws IOException,
AutomationException
setWidth in interface IMarker3DPlacementwidth - The width (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getDepth()
throws IOException,
AutomationException
getDepth in interface IMarker3DPlacementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDepth(double depth)
throws IOException,
AutomationException
setDepth in interface IMarker3DPlacementdepth - The depth (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isMaintainAspectRatio()
throws IOException,
AutomationException
isMaintainAspectRatio in interface IMarker3DPlacementIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaintainAspectRatio(boolean bAspectRatio)
throws IOException,
AutomationException
setMaintainAspectRatio in interface IMarker3DPlacementbAspectRatio - The bAspectRatio (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getSize()
throws IOException,
AutomationException
getSize in interface IMarkerSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSize(double size)
throws IOException,
AutomationException
setSize in interface IMarkerSymbolsize - The size (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IColor getColor()
throws IOException,
AutomationException
getColor in interface IMarkerSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IHsvColor,
IHlsColor
public void setColor(IColor color)
throws IOException,
AutomationException
setColor in interface IMarkerSymbolcolor - A reference to a com.esri.arcgis.display.IColor (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IHsvColor,
IHlsColor
public double getAngle()
throws IOException,
AutomationException
getAngle in interface IMarkerSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAngle(double angle)
throws IOException,
AutomationException
setAngle in interface IMarkerSymbolangle - The angle (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getXOffset()
throws IOException,
AutomationException
getXOffset in interface IMarkerSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setXOffset(double xOffset)
throws IOException,
AutomationException
setXOffset in interface IMarkerSymbolxOffset - The xOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getYOffset()
throws IOException,
AutomationException
getYOffset in interface IMarkerSymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setYOffset(double yOffset)
throws IOException,
AutomationException
setYOffset in interface IMarkerSymbolyOffset - The yOffset (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getMapLevel()
throws IOException,
AutomationException
getMapLevel in interface IMapLevelIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMapLevel(int mapLevel)
throws IOException,
AutomationException
setMapLevel in interface IMapLevelmapLevel - The mapLevel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setupDC(int hDC,
ITransformation transformation)
throws IOException,
AutomationException
setupDC in interface ISymbolhDC - The hDC (A COM typedef) (in)transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void resetDC()
throws IOException,
AutomationException
resetDC in interface ISymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void draw(IGeometry geometry)
throws IOException,
AutomationException
draw in interface ISymbolgeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryBoundary(int hDC,
ITransformation displayTransform,
IGeometry geometry,
IPolygon boundary)
throws IOException,
AutomationException
Valid input Geometries are as follows:
For MarkerSymbols, the Geometry must be an IPoint.
For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.
For Line Symbols, the Geometry must be an IPolyline.
queryBoundary in interface ISymbolhDC - The hDC (A COM typedef) (in)displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getROP2()
throws IOException,
AutomationException
getROP2 in interface ISymbolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setROP2(int drawMode)
throws IOException,
AutomationException
setROP2 in interface ISymboldrawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean applies(Object pUnk)
throws IOException,
AutomationException
Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
applies in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canApply(Object pUnk)
throws IOException,
AutomationException
CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.
CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.
canApply in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getCurrent(Object pUnk)
throws IOException,
AutomationException
getCurrent in interface IPropertySupportpUnk - A reference to another Object (IUnknown) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object apply(Object newObject)
throws IOException,
AutomationException
Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.
Use the Applies and CanApply methods to determine if an Apply can be used on an object.
apply in interface IPropertySupportnewObject - A reference to another Object (IUnknown) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws IOException,
AutomationException
esri_clone in interface ICloneIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws IOException,
AutomationException
IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws IOException,
AutomationException
IsIdentical returns true if the receiver and the source reference the same object.
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getNameString()
throws IOException,
AutomationException
getNameString in interface IDisplayNameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isBillboardDisplay()
throws IOException,
AutomationException
isBillboardDisplay in interface IBillboardDisplayIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBillboardDisplay(boolean pBillboard)
throws IOException,
AutomationException
setBillboardDisplay in interface IBillboardDisplaypBillboard - The pBillboard (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||