hep.graphics.heprep
Interface HepRepInstance

All Superinterfaces:
HepRepAttribute, HepRepConstants

public interface HepRepInstance
extends HepRepAttribute

HepRepInstance interface.

Author:
Mark Donszelmann

Field Summary
 
Fields inherited from interface hep.graphics.heprep.HepRepConstants
SHOW_DESC, SHOW_EXTRA, SHOW_NAME, SHOW_NONE, SHOW_VALUE, TYPE_BOOLEAN, TYPE_COLOR, TYPE_DOUBLE, TYPE_INT, TYPE_LONG, TYPE_STRING, TYPE_UNKNOWN
 
Method Summary
 void addInstance(HepRepInstance instance)
          Adds an sub-instance to this instance.
 void addPoint(HepRepPoint point)
          Adds a point to this instance.
 HepRepInstance copy(HepRepTypeTree typeTree, HepRepInstance parent)
          Returns a deep copy of this instance.
 HepRepInstance copy(HepRepTypeTree typeTree, HepRepInstance parent, HepRepSelectFilter filter)
          Returns a deep copy of this instance.
 HepRepInstance copy(HepRepTypeTree typeTree, HepRepInstanceTree parent)
          Returns a deep copy of this instance.
 HepRepInstance copy(HepRepTypeTree typeTree, HepRepInstanceTree parent, HepRepSelectFilter filter)
          Returns a deep copy of this instance.
 List getInstances()
          Returns a collection of all sub-instances this instance keeps.
 String getLayer()
          Returns String layername.
 List getPoints()
          Returns a collection of all points this instance keeps.
 int getPoints(double[][] xyz)
          Fills a double[3][n] array with the coordinates of all points, if none of the points have any attributes defined on them.
 HepRepInstance getSuperInstance()
          Returns the parent of this instance.
 HepRepType getType()
          Returns the associated type for this instance.
 Object getUserObject()
          Returns a user object previously set on this instance.
 boolean hasFrame()
          Returns true if this instance has a frame.
 void overlay(HepRepInstance instance)
          Overlays the instance on the current instance.
 void removeInstance(HepRepInstance instance)
          Removes a sub-instance from this instance.
 void setUserObject(Object object)
          Sets a User Object on this instance.
 
Methods inherited from interface hep.graphics.heprep.HepRepAttribute
addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, getAttValue, getAttValueFromNode, getAttValuesFromNode, removeAttValue
 

Method Detail

overlay

void overlay(HepRepInstance instance)
Overlays the instance on the current instance. Attributes of the instance override or are added to the current instance. Sub-instances of the instance are added only if the current instance has no sub-instances. Points of the instance are added only if the current instance has no points.

Parameters:
instance - instance to overlay

addInstance

void addInstance(HepRepInstance instance)
Adds an sub-instance to this instance.

Parameters:
instance - sub-instance.

removeInstance

void removeInstance(HepRepInstance instance)
Removes a sub-instance from this instance.

Parameters:
instance - sub-instance.

getInstances

List getInstances()
Returns a collection of all sub-instances this instance keeps.

Returns:
collection of HepRepInstances.

getType

HepRepType getType()
Returns the associated type for this instance.

Returns:
associated HepRepType.

addPoint

void addPoint(HepRepPoint point)
Adds a point to this instance.

Parameters:
point - to be added.

getPoints

List getPoints()
Returns a collection of all points this instance keeps.

Returns:
collection of HepRepPoints.

getPoints

int getPoints(double[][] xyz)
Fills a double[3][n] array with the coordinates of all points, if none of the points have any attributes defined on them. The actual number of points filled is returned. If any points have attributes, or returning a list is not possible -1 is returned. One could then call getPoint(). If the number of points is larger than n, the array is filled (either with the first n points or a mix of points) and -numberOfPoints is returned.

Returns:
number of points filled in xyz, or -1 in case of error or non-implementation or -number of points that were available (xyz is filled but too small). ONLY in JAVA

hasFrame

boolean hasFrame()
Returns true if this instance has a frame. Speedy access for iterator.

Returns:
tue if instance should have frame ONLY in JAVA

getLayer

String getLayer()
Returns String layername. Speedy access for iterator.

Returns:
layer name ONLY in JAVA

getSuperInstance

HepRepInstance getSuperInstance()
Returns the parent of this instance.

Returns:
parent of instance, or null if top-level.

copy

HepRepInstance copy(HepRepTypeTree typeTree,
                    HepRepInstance parent)
                    throws CloneNotSupportedException
Returns a deep copy of this instance.

Parameters:
typeTree - needed to find the associated type.
parent - to which the copy is added.
Returns:
copy of this instance.
Throws:
CloneNotSupportedException - if copying is not possible.

copy

HepRepInstance copy(HepRepTypeTree typeTree,
                    HepRepInstance parent,
                    HepRepSelectFilter filter)
                    throws CloneNotSupportedException
Returns a deep copy of this instance.

Parameters:
typeTree - needed to find the associated type.
parent - to which the copy is added.
filter - run on all instances before copying.
Returns:
copy of this instance.
Throws:
CloneNotSupportedException - if copying is not possible.

copy

HepRepInstance copy(HepRepTypeTree typeTree,
                    HepRepInstanceTree parent)
                    throws CloneNotSupportedException
Returns a deep copy of this instance.

Parameters:
typeTree - needed to find the associated type.
parent - to which the copy is added.
Returns:
copy of this instance.
Throws:
CloneNotSupportedException - if copying is not possible.

copy

HepRepInstance copy(HepRepTypeTree typeTree,
                    HepRepInstanceTree parent,
                    HepRepSelectFilter filter)
                    throws CloneNotSupportedException
Returns a deep copy of this instance.

Parameters:
typeTree - needed to find the associated type.
parent - to which the copy is added.
filter - run on all instances before copying.
Returns:
copy of this instance.
Throws:
CloneNotSupportedException - if copying is not possible.

setUserObject

void setUserObject(Object object)
Sets a User Object on this instance.

Parameters:
object - User Object.

getUserObject

Object getUserObject()
Returns a user object previously set on this instance.

Returns:
User Object.


Copyright 2000-2007 FreeHEP. All Rights Reserved.