org.eclipse.eavp.geometry.view.model

Interface DisplayOption<T>

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

ColorOption<T>, OpacityOption<T>, ScaleOption<T>, WireframeOption<T>

All Known Implementing Classes:

ColorOptionImpl, DisplayOptionImpl, FXColorOption, FXOpacityOption, FXScaleOption, FXWireframeOption, OpacityOptionImpl, ScaleOptionImpl, WireframeOptionImpl

public interface DisplayOption<T>
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Display Option'. This class contains additional optional rendering information that will be applied to the containing RenderObject's data. A DisplayOption will offer addional functionality beyond that provided by the RenderObject simply specifiyng the geometry for the shape.

The following features are supported:

• Active
• Option Group
• Parent
• Type

See Also:

ModelPackage.getDisplayOption()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getDefaultProperties()
IDisplayOptionData	getDisplayOptionData()
java.lang.String	getOptionGroup() Returns the value of the 'Option Group' attribute.
RenderObject<?>	getParent() Returns the value of the 'Parent' reference.
DisplayOptionType	getType() Returns the value of the 'Type' attribute.
boolean	isActive() Returns the value of the 'Active' attribute.
void	modify(T element) Apply this option's modifications to the given mesh.
void	setActive(boolean value) Sets the value of the 'Active' attribute.
void	setOptionGroup(java.lang.String value) Sets the value of the 'Option Group' attribute.
void	setParent(RenderObject<?> value) Sets the value of the 'Parent' reference.
void	setType(DisplayOptionType value) Sets the value of the 'Type' attribute.

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

isActive

boolean isActive()

Returns the value of the 'Active' attribute. The default value is "true". Whether the option is currently active. If false, the DisplayOption will not have any effect, the same as if it were not in the RenderObject's list of options. If true, it will apply its changes to the RenderObject's mesh.

Returns:

the value of the 'Active' attribute.

See Also:

setActive(boolean), ModelPackage.getDisplayOption_Active()

setActive

void setActive(boolean value)

Sets the value of the 'Active' attribute.

Parameters:

value - the new value of the 'Active' attribute.

See Also:

isActive()

getOptionGroup

java.lang.String getOptionGroup()

Returns the value of the 'Option Group' attribute. The option group to which this DisplayOption belongs. The option group will determing the name under which the DisplayOption's controls will be published to users and will allow conceptually related options to share the same control.

Returns:

the value of the 'Option Group' attribute.

See Also:

setOptionGroup(String), ModelPackage.getDisplayOption_OptionGroup()

setOptionGroup

void setOptionGroup(java.lang.String value)

Sets the value of the 'Option Group' attribute.

Parameters:

value - the new value of the 'Option Group' attribute.

See Also:

getOptionGroup()

getParent

RenderObject<?> getParent()

Returns the value of the 'Parent' reference.

If the meaning of the 'Parent' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Parent' reference.

See Also:

setParent(RenderObject), ModelPackage.getDisplayOption_Parent()

setParent

void setParent(RenderObject<?> value)

Sets the value of the 'Parent' reference.

Parameters:

value - the new value of the 'Parent' reference.

See Also:

getParent()

getType

DisplayOptionType getType()

Returns the value of the 'Type' attribute. The literals are from the enumeration DisplayOptionType. The type of control which best corresponds to this class's configuraiton options.

Returns:

the value of the 'Type' attribute.

See Also:

DisplayOptionType, setType(DisplayOptionType), ModelPackage.getDisplayOption_Type()

setType

void setType(DisplayOptionType value)

Sets the value of the 'Type' attribute.

Parameters:

value - the new value of the 'Type' attribute.

See Also:

DisplayOptionType, getType()

modify

void modify(T element)

Apply this option's modifications to the given mesh.

getDefaultProperties

java.util.Map<java.lang.String,java.lang.Object> getDefaultProperties()

getDisplayOptionData

IDisplayOptionData getDisplayOptionData()