ITerrainEffect80

This interface gives the client access to the animation effect object.

Using particle system animations, TerraExplorer simulates natural phenomena such as fire, smoke, and explosions, or fireworks, by modeling the underlying physical processes of these phenomena. TerraExplorer uses a versatile, powerful particle system that captures important elements of each effect with realistic colors and intensity to effectively simulate different phenomena.

	Properties
	Action	An IAction80 representing the operation that takes place when the object is clicked in the Project Tree.
	Attachment	An IAttachment80 representing the attachment behavior of the object.
	EffectXML	Gets and sets an XML that defines the effect properties.
	LimitScreenSize	Gets and sets a Boolean that determines whether the effect object keeps its original size in pixels or whether it grows as you fly closer.
	LineColor	An IColor80 representing the color of the line to ground from the effect object.
	LineToGroundLength	Gets and sets the length of the line that extends down from the effect object’s pivot either to the ground or to a custom length towards the ground.
	LineToGroundType	Gets and sets an enum that determines if a line extends down from the effect object’s pivot point towards the ground.
	MaxViewingHeight	Gets and sets the maximum viewing height at which the effect object is visible.
	Message	An IMessageObject80 representing the message object assigned to the animation effect object.
	MinViewingHeight	Gets and sets the minimum viewing height at which the effect object is visible.
	Position	An IPosition80 representing the position and orientation of the object on the terrain.
	Scale	Gets and sets the animation effect’s dimensions, in meters per pixel.
	SmallestVisibleSize	Gets and sets the minimum height, in pixels, at which the effect object disappears as you fly away from it.
	Terrain	An ITerrainObject80 representing the object’s terrain properties including draw order and ground object status.
	Timespan	An ITimeSpan80 representing the timespan in which the object is visible on the terrain.
	Tooltip	An ITooltip80 representing the tooltip that displays when a mouse cursor is placed over the object in the 3D Window.
	Visibility	An IVisibility80 representing the visibility of the arrow at different distances.

EffectXML

Gets and sets an XML that defines the animation effect’s particle system parameters, such as the shape and size of the particle emitter, and shape and scale factor of the volume that the particles are emitted into. See “Particle Editor Parameters” in the “Effects” chapter in the TerraExplorer User Manual for a description of the XML’s particle system parameters.

Note: The animation effects themselves are created by calling ICreator80. CreateEffect.

JavaScript
EffectXML

C#
string EffectXML { get; set; }

C++

HRESULT EffectXML([out, retval] BSTR* xml)

HRESULT EffectXML([in] BSTR xml)

LimitScreenSize

Gets and sets a Boolean that determines whether the animation effect keeps its original size in pixels or whether it grows as you fly closer.

JavaScript
LimitScreenSize()

C#
bool LimitScreenSize { get; set; }

C++

HRESULT LimitScreenSize([out, retval] *VARIANT_BOOL pVal)

HRESULT LimitScreenSize([in] *VARIANT_BOOL pVal)

LineToGroundLength

Gets and sets the length of the line that extends down from the effect’s pivot either to the ground or to a custom length towards the ground.

JavaScript
LineToGroundLength

C#
bool LineToGroundLength { get; set; }

C++

HRESULT LineToGroundLength([out, retval] double* pVal)

HRESULT LineToGroundLength([in] double pVal)

LineToGroundType

Gets and sets an enum that determines if a line extends down from the pivot either to the ground or to a custom length towards the ground. The following are the possible values:

§ LINE_TYPE_NONE = 0
No line to ground is extended from the pivot.

§ LINE_TYPE_TO_GROUND = 1
A line is extended from the pivot down to the ground.

§ LINE_TYPE_CUSTOM = 2
A line is extended from the pivot to a custom length towards the ground.

JavaScript
LineToGroundType

C#
bool LineToGroundType { get; set; }

C++

HRESULT LineToGroundType([out, retval] LineType* pVal)

HRESULT LineToGroundType([in] LineType pVal)

MaxViewingHeight

Gets and sets the maximum viewing height at which the effect object is visible.

JavaScript
MaxViewingHeight

C#
double MaxViewingHeight { get; set; }

C++

HRESULT MaxViewingHeight([out, retval] double* pVal)

HRESULT MaxViewingHeight([in] double pVal)

MinViewingHeight

Gets and sets the minimum viewing height for which the effect object is visible. When flying lower than the MinViewingHeight, the effect object disappears.

JavaScript
MinViewingHeight

C#
double MinViewingHeight { get; set; }

C++

HRESULT MinViewingHeight([out, retval] double* pVal)

HRESULT MinViewingHeight([in] double pVal)

Scale

Gets and sets the dimensions, in meters per pixel, of the effect object.

JavaScript
Scale

C#
double Scale { get; set; }

C++

HRESULT Scale([out, retval] double* pVal)

HRESULT Scale([in] double pVal)

SmallestVisibleSize

Gets and sets the minimum height, in pixels, at which the effect object disappears as you fly away from it.

JavaScript
SmallestVisibleSize

C#
int SmallestVisibleSize { get; set; }

C++

HRESULT SmallestVisibleSize ([out, retval] long* pVal)

HRESULT SmallestVisibleSize ([in] long pVal)