Luciad.Layers.Features.FeatureState Class Reference

Representation of the state of a feature. More...

Inheritance diagram for Luciad.Layers.Features.FeatureState:

Public Member Functions
void	Dispose ()
override bool	Equals (object other)
override int	GetHashCode ()

Static Public Member Functions
static FeatureState	GetValue (string name)
	Returns the FeatureState with the given name. More...
static FeatureState	RegisterValue (string name)
	Registers a new FeatureState with the given name. More...

Properties
static FeatureState	Hover = HoverInternal() [get]
string	Name [get]
static FeatureState	Selected = SelectedInternal() [get]
static System.Collections.Generic.IList< FeatureState >	Values [get]

Detailed Description

Representation of the state of a feature.

By default the following states exist: selected hover

It is possible to register custom feature states using FeatureState::registerValue. You can use such custom feature states to style objects differently.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureState.

Member Function Documentation

Dispose()

void Luciad.Layers.Features.FeatureState.Dispose ( )

inline

Equals()

override bool Luciad.Layers.Features.FeatureState.Equals ( object  other )

inline

GetHashCode()

override int Luciad.Layers.Features.FeatureState.GetHashCode ( )

inline

GetValue()

Luciad.Layers.Features.FeatureState Luciad.Layers.Features.FeatureState.GetValue ( string  name )

inlinestatic

Returns the FeatureState with the given name.

If no such FeatureState exists, an exception will be thrown.

name

the name of the FeatureState.

the FeatureState with the given name.

InvalidArgumentException

if there is no feature state for the given name.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureState::getValue.

RegisterValue()

Luciad.Layers.Features.FeatureState Luciad.Layers.Features.FeatureState.RegisterValue ( string  name )

inlinestatic

Registers a new FeatureState with the given name.

It is not allows the register multiple FeatureStates with the same name. If not, an exception will be thrown.

name

the name for the feature state. Must be unique.

InvalidArgumentException

if the value already exists.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureState::registerValue.

Property Documentation

Hover

FeatureState Luciad.Layers.Features.FeatureState.Hover = HoverInternal()

staticget

Name

string Luciad.Layers.Features.FeatureState.Name

get

Selected

FeatureState Luciad.Layers.Features.FeatureState.Selected = SelectedInternal()

staticget

Values

System.Collections.Generic.IList<FeatureState> Luciad.Layers.Features.FeatureState.Values

staticget