IDrawing80

The IDrawing interface provides methods for interactive user drawing capabilities. Events during and after the interactive drawing allow the drawing process and the object style to be controlled.

	Methods
	DrawCircle	Activates an interactive mode for drawing a circle.
	DrawDynamicObject	Activates an interactive mode for drawing a dynamic object.
	DrawImageLabel	Activates an interactive mode for drawing an image label in the 3D World.
	DrawModel	Activates an interactive mode for drawing a model.
	DrawPolygon	Activates an interactive mode for drawing a polygon in the 3D World.
	DrawPolyline	Activates an interactive mode for drawing a polyline in the 3D World.
	DrawRectangle	Activates an interactive mode for drawing a rectangle in the 3D World.
	DrawTextLabel	Activates an interactive mode for drawing a text label in the 3D World.

DrawCircle

Activates an interactive mode for drawing a circle in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainRegularPolygon return object can be used to set any of the properties of the drawn circle.

Note: The Position or Geometry of the returning IterrainRegularPolygon circle should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawCircle(

DrawingMode,

GroupID,

Left,

Top)

IterrainRegularPolygon80 DrawCircle (

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue)

C++

HRESULT DrawCircle (

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,

[in] long Top,

[out, retval] IterrainRegularPolygon80** pITerrainRegularPolygon80)

Parameters

DrawingMode

An enum that determines an object's initial move mode, i.e., how it is moved in the 3D Window, and how the property sheet is displayed when the object is created. The DrawingMode enum is divided into two subgroups. This parameter can use a combination of values from the two subgroups, but no more than one value from each subgroup can be used.

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_MAGNET = 4
Sets the edit mode to move the object based on where the mouse is pointing in the 3D Window. This makes it easier to move an object or node on a vertical plane or above a 3DML layer or other terrain object.

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the circle object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainRegularPolygon80

An IterrainRegularPolygon representing the circle drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DrawDynamicObject

Activates an interactive mode for drawing a dynamic object in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainDynamicObject return object can be used to set any of the properties of the drawn dynamic object.

Note: The Position of the returning ITerrainDynamicObject should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawDynamicObject (

Path,

DrawingMode,

GroupID,

Left,

Top)

ITerrainDynamicObject80 DrawDynamicObject (

String Path,

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue)

C++

HRESULT DrawDynamicObject (

[in] BSTR Path,

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,
[in] long Top,

[out, retval] ITerrainDynamicObject80** pITerrainDynamicObject80)

Parameters

Path

Full path to the model file or image file to be used for the dynamic object.

DrawingMode

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the dynamic object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainDynamicObject80

An ITerrainDynamicObject representing the dynamic object drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DrawImageLabel

Activates an interactive mode for drawing an image label in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainLabel return object can be used to set any of the properties of the drawn label.

Note: The Position of the returning ITerrainLabel label should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawImageLabel (

ImagePath,

DrawingMode,

GroupID,

Left,

Top)

ITerrainLabel80 DrawImageLabel (

String ImagePath,

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue)

C++

HRESULT DrawImageLabel (

[in] BSTR ImagePath,

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,

[in] long Top,

[out, retval] ITerrainLabel80** pITerrainLabel80)

Parameters

ImagePath

Full path to a BMP, JPEG, GIF, PNG or ICO file to load as the image for the image label.

DrawingMode

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the label object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet .

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainLabel80

An ITerrainLabel representing the image label drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DrawModel

Activates an interactive mode for placing a pre-prepared 3D model in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainModel return object can be used to set any of the properties of the placed model.

Note: The Position of the returning ITerrainModel model should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawModel (

Path,

DrawingMode,

GroupID,

Left,

Top)

ITerrainModel80 DrawModel (

String Path,

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue)

C++

HRESULT DrawModel (

[in] BSTR Path,

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,
[in] long Top,

[out, retval] ITerrainModel80** pITerrainModel80)

Parameters

Path

Full path to the 3D model file.

DrawingMode

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the model object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainModel80

An ITerrainModel representing the model drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DrawPolygon

Activates an interactive mode for drawing a polygon in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainPolygon return object can be used to set any of the properties of the drawn polygon.

Note: The Position or Geometry of the returning ITerrainPolygon polygon should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawPolygon(

DrawingMode,

GroupID,

Left,

Top)

ITerrainPolygon80 DrawPolygon (

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue)

C++

HRESULT DrawPolygon (

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,
[in] long Top,

[out, retval] ITerrainPolygon80** pITerrainPolygon80)

Parameters

DrawingMode

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the polygon object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainPolygon80

An ITerrainPolygon representing the polygon drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DrawPolyline

Activates an interactive mode for drawing a polyline in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainPolyline return object can be used to set any of the properties of the drawn polyline.

Note: The Position or Geometry of the returning ITerrainPolyline polyline should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawPolyline(

DrawingMode,

GroupID)

ITerrainPolyline80 DrawPolyline(

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue)

C++

HRESULT DrawPolyline(

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,
[in] long Top,

[out, retval] ITerrainPolyline80** pITerrainPolyline80)

Parameters

DrawingMode

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the polyline object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainPolyline80

An ITerrainPolyline representing the polyline drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DrawRectangle

Activates an interactive mode for drawing a rectangle in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainRectangle return object can be used to set any of the properties of the drawn rectangle.

Note: The Position or Geometry of the returning ITerrainRectangle rectangle should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawRectangle(

DrawingMode,

GroupID,

Left,

Top)

ITerrainRectangle80 DrawRectangle (

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue]

C++

HRESULT DrawRectangle (

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,
[in] long Top,

[out, retval] ITerrainRectangle80** pITerrainRectangle80)

Parameters

DrawingMode

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the rectangle object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainRectangle80

An ITerrainRectangle representing the rectangle drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DrawTextLabel

Activates an interactive mode for drawing a text label in the 3D World. The drawing process and style can be controlled using the related drawing events: OnDrawingAbort, OnDrawingFinished, and OnDrawingGeometryChanged. The ITerrainLabel return object can be used to set any of the properties of the drawn label.

Note: The Position of the returning ITerrainLabel label should not be modified until the draw action is complete, i.e., until the OnDrawingFinished event is sent.

JavaScript

DrawTextLabel (

Text,

DrawingMode,

GroupID,

Left,

Top)

ITerrainLabel80 DrawTextLabel (

string Text,

TerraExplorerX.DrawingMode = DrawingMode.DRAW_MODE_MAGNET,

string GroupID = "",

int Left = int.MaxValue,

int Top = int.MaxValue)

C++

HRESULT DrawTextLabel(

[in] BSTR Text,

[in] DrawingMode DrawingMode,

[in] BSTR GroupID,

[in] long Left,
[in] long Top,

[out, retval] ITerrainLabel80** pITerrainLabel80)

Parameters

Text

The label text.

DrawingMode

Property Sheet Display Group – Use only one of the following values:

· DRAW_MODE_SHOW_PROPERTY = 1
Open the property sheet including the top toolbar to edit the object.

· DRAW_MODE_SHOW_PROPERTY_PANEL = 2
Open only the property sheet toolbar to edit the item.

Move Mode Group – Use only one of the following values:

· DRAW_MODE_XY = 8
Set the edit mode to move the object in the XY plane.

GroupID

The ID of the group in which the label object should be created.

Left

The top left X position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Top

The top left Y position (in pixels) of the object's property sheet relative to the last position of the property sheet.

Return Value

pITerrainLabel80

An ITerrainLabel representing the text label drawn. The return object can be used to set any of the properties of the drawn object.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.