Google Earth COM API Documentation Document Version: 1.0 - Last modified:

IFeatureGE Interface Reference

This is a basic representation of a KML feature. More...

import "earth.idl";

List of all members.

Public Member Functions
HRESULT	Highlight ()
	Highlights feature on the UI.
HRESULT	GetParent ([out, retval] IFeatureGE **pParent)
	Retrieves feature's parent feature.
HRESULT	GetChildren ([out, retval] IFeatureCollectionGE **pChildren)
	Retrieves children as a collection of features.
Properties
BSTR	Name [get]
	Feature's name.
BOOL	Visibility [get, set]
	Whether or not feature is visible.
BOOL	HasView [get]
	Whether or not feature has a view.
BOOL	Highlighted [get]
	Whether or not feature is currently highlighted on the UI.
ITimeIntervalGE	TimeInterval [get]
	Time interval of feature's availability.

---

Detailed Description

This is a basic representation of a KML feature.

Use the IFeatureGE interface to describes KML represented by an item in the "Places" and "Layers" panels in the Google Earth application. This includes placemarks, overlays, folders, documents, network links, and streamed layers.

Associated GUIDs:

• IID_IFeatureGE = {0x92547B06,0x0007,0x4820, {0xB7,0x6A,0xC8,0x4E,0x40,0x2C,0xA7,0x09}};
• CLSID_FeatureGE = {0xCBD4FB70,0xF00B,0x4963, {0xB2,0x49,0x4B,0x05,0x6E,0x6A,0x98,0x1A}};

---

Member Function Documentation

HRESULT IFeatureGE::Highlight

(

)

Highlights feature on the UI.

Sets feature as the current selected on the UI. Useful for various situations such as for playing tours.

Return values:

	S_OK	Successfully highlighted feature.
	(other)	Appropriate error code.

See also:

Highlighted

HRESULT IFeatureGE::GetParent

(

[out, retval] IFeatureGE **

pParent

)

Retrieves feature's parent feature.

Finds the parent feature (if any) that contains this feature. Useful for traversing features.

Parameters:

pParent

output parent feature. Set to NULL if feature has no parent.

Return values:

	S_OK	pParent was properly set to feature's parent or to NULL if feature has no parent.
	(other)	appropriate error code (e.g. problems creating feature object).

See also:

GetChildren

HRESULT IFeatureGE::GetChildren

(

[out, retval] IFeatureCollectionGE **

pChildren

)

Retrieves children as a collection of features.

Finds feature's children and returns them in form of an IFeatureCollectionGE. Useful for traversing features.

Parameters:

pChildren

output enum representing the sequence of feature's children. If function returns successfully, this is never NULL. However, it may represent an empty sequence if feature: has no children (e.g. is a placemark or empty folder), or is non-expandable (i.e. has children that cannot be shown or are unvailable).

Return values:

	S_OK	pChildren was successfully populated
	(other)	appropriate error code (e.g. problems creating enum object).

See also:

GetParent

---

Property Documentation

BSTR IFeatureGE::Name [get]

Feature's name.

The (non-unique) name string of the feature. Features with no name are represented by the empty string.

See also:

IApplicationGE::GetFeatureByName

BOOL IFeatureGE::Visibility [get, set]

Whether or not feature is visible.

This basically indicates whether the corresponding item is checked or unchecked on the UI.

For example, if the "roads" feature is visible, then its corresponding UI checkbox will be checked and roads will show up on the Earth.

Note:

Changing the visibility of a folder forces a change in visibility for all its children. If a folder is partially visible (i.e. some of its children are visible and some are not), then the folder is considered "visible".

See also:

GetChildren

BOOL IFeatureGE::HasView [get]

Whether or not feature has a view.

This indicates whether or not it is possible to "fly" to that feature. Typically, placemarks have a view, while folders, documents, and streamed layers do not have a view.

This method is useful to know whether or not it is possible to use this feature as an argument to IApplicationGE::SetFeatureView.

See also:

IApplicationGE::SetFeatureView.

BOOL IFeatureGE::Highlighted [get]

Whether or not feature is currently highlighted on the UI.

This property corresponds to whether or not this feature is currently selected on the UI. To select this feature, use Highlight.

See also:

Highlight

ITimeIntervalGE IFeatureGE::TimeInterval [get]

Time interval of feature's availability.

The (beginTime, endTime) time interval of when the feature is available (e.g. visible). Represented as a read-only deep copy (i.e. properties will return ERROR_WRITE_PROTECT at any attempt to change them).

---

The documentation for this interface was generated from the following file:

• earth.idl

©2008 Google - Google Home - About Google