org.eclipse.january.geometry

Interface INode

All Superinterfaces:

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

All Known Subinterfaces:

Complement, Cube, Cylinder, Geometry, HeatExchanger, Intersection, Junction, Operator, Pipe, PolyShape, Reactor, Shape, Sphere, TriangleStripPolyShape, Tube, Union

All Known Implementing Classes:

ComplementImpl, CubeImpl, CylinderImpl, GeometryImpl, HeatExchangerImpl, IntersectionImpl, JunctionImpl, OperatorImpl, PipeImpl, PolyShapeImpl, ReactorImpl, ShapeImpl, SphereImpl, TriangleStripPolyShapeImpl, TubeImpl, UnionImpl

public interface INode
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'INode'. An INode represents a single node in a geometry tree.

The following features are supported:

• Name
• Id
• Nodes
• Type
• Triangles
• Center
• Parent

See Also:

GeometryPackage.getINode()

Method Summary

Modifier and Type	Method and Description
void	addNode(INode child) Add a child to the list of children nodes contained by this object.
void	addNodes(org.eclipse.emf.common.util.EList<INode> children) Allows for multiple nodes to be added simultaneously, maintaining the parent reference for each new node.
void	changeDecoratorProperty(java.lang.String property, java.lang.Object value) Fire a notification that will alert decorator pattern classes registered to this object that they should change their state.
java.lang.Object	clone() Create a copy of this object.
void	copy(java.lang.Object source) Make this object a copy of the source object, if the source object is of an appropriate type.
Vertex	getCenter() Returns the value of the 'Center' reference.
long	getId() Returns the value of the 'Id' attribute.
java.lang.String	getName() Returns the value of the 'Name' attribute.
org.eclipse.emf.common.util.EList<INode>	getNodes() Returns the value of the 'Nodes' containment reference list.
INode	getParent() Returns the value of the 'Parent' reference.
double	getProperty(java.lang.String property) Get the value for one of the shape's properties.
org.eclipse.emf.common.util.EList<java.lang.String>	getPropertyNames() Get the names of all properties set for this shape.
org.eclipse.emf.common.util.EList<Triangle>	getTriangles() Returns the value of the 'Triangles' containment reference list.
java.lang.String	getType() Returns the value of the 'Type' attribute.
void	removeNode(INode child) Remove a child from the list of children nodes contained by this object.
void	setCenter(Vertex value) Sets the value of the 'Center' reference.
void	setId(long value) Sets the value of the 'Id' attribute.
void	setName(java.lang.String value) Sets the value of the 'Name' attribute.
void	setParent(INode value) Sets the value of the 'Parent' reference.
void	setProperty(java.lang.String property, double value) Set one of the Shape's properties.
void	setType(java.lang.String 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

getName

java.lang.String getName()

Returns the value of the 'Name' attribute. The name of the node.

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), GeometryPackage.getINode_Name()

setName

void setName(java.lang.String value)

Sets the value of the 'Name' attribute.

Parameters:

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

See Also:

getName()

getId

long getId()

Returns the value of the 'Id' attribute. An optional node id to identify the node numerically.

Returns:

the value of the 'Id' attribute.

See Also:

setId(long), GeometryPackage.getINode_Id()

setId

void setId(long value)

Sets the value of the 'Id' attribute.

Parameters:

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

See Also:

getId()

getNodes

org.eclipse.emf.common.util.EList<INode> getNodes()

Returns the value of the 'Nodes' containment reference list. The list contents are of type INode. The list of nodes that compose the head node.

Returns:

the value of the 'Nodes' containment reference list.

See Also:

GeometryPackage.getINode_Nodes()

getType

java.lang.String getType()

Returns the value of the 'Type' attribute. A string representing the type of entity this node represents in the tree in a human readable way. Example values might include "cube", "sphere" or "intersection."

Returns:

the value of the 'Type' attribute.

See Also:

setType(String), GeometryPackage.getINode_Type()

setType

void setType(java.lang.String value)

Sets the value of the 'Type' attribute.

Parameters:

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

See Also:

getType()

getTriangles

org.eclipse.emf.common.util.EList<Triangle> getTriangles()

Returns the value of the 'Triangles' containment reference list. The list contents are of type Triangle. A series of triangles which comprise the mesh which will represent this object graphically. If this list is empty, it will be the responsibility of other classes to determine, based on this INode's "type", what mesh, if any, should be displayed for it.

Returns:

the value of the 'Triangles' containment reference list.

See Also:

GeometryPackage.getINode_Triangles()

getCenter

Vertex getCenter()

Returns the value of the 'Center' reference. Each shape is centered on a special vertex.

Returns:

the value of the 'Center' reference.

See Also:

setCenter(Vertex), GeometryPackage.getINode_Center()

setCenter

void setCenter(Vertex value)

Sets the value of the 'Center' reference.

Parameters:

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

See Also:

getCenter()

getParent

INode 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(INode), GeometryPackage.getINode_Parent()

setParent

void setParent(INode value)

Sets the value of the 'Parent' reference.

Parameters:

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

See Also:

getParent()

changeDecoratorProperty

void changeDecoratorProperty(java.lang.String property,
                             java.lang.Object value)

Fire a notification that will alert decorator pattern classes registered to this object that they should change their state. This method is intended to cause change in the INode's graphical representation in a non-permanent way, by modifying qualities such as opacity which are purely concerned with rendering and do not belong to the modeling data itself. "Property" should offer sufficient description for the client to determine "value"'s type.

getPropertyNames

org.eclipse.emf.common.util.EList<java.lang.String> getPropertyNames()

Get the names of all properties set for this shape.

getProperty

double getProperty(java.lang.String property)

Get the value for one of the shape's properties.

Parameters:

property - The name of the property whose value is to be returned.

setProperty

void setProperty(java.lang.String property,
                 double value)

Set one of the Shape's properties.

Parameters:

property - The name of the property whose value is being set.

value - The property's new value.

addNode

void addNode(INode child)

Add a child to the list of children nodes contained by this object. It is intended that users will use addNode() instead of adding objects directly to the nodes list to properly maintain the child's parent attribute.

addNodes

void addNodes(org.eclipse.emf.common.util.EList<INode> children)

Allows for multiple nodes to be added simultaneously, maintaining the parent reference for each new node.

Parameters:

children - List of nodes to add as children under this node

removeNode

void removeNode(INode child)

Remove a child from the list of children nodes contained by this object. It is intended that users will use removeNode() instead of adding objects directly to the nodes list to properly maintain the child's parent attribute.

copy

void copy(java.lang.Object source)

Make this object a copy of the source object, if the source object is of an appropriate type.

clone

java.lang.Object clone()

Create a copy of this object.