artisynth.core.modelbase

Class ComponentUtils

java.lang.Object

artisynth.core.modelbase.ComponentUtils

public class ComponentUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static char	componentPropertySeparator

Constructor Summary

Constructors

Constructor and Description
ComponentUtils()

Method Summary

Modifier and Type	Method and Description
static void	addComponents(java.util.List<? extends ModelComponent> list, int[] indices, java.util.List<MutableCompositeComponent<?>> parents)
static void	addComponents(java.util.List<? extends ModelComponent> list, int[] indices, java.util.List<MutableCompositeComponent<?>> parents, boolean reverse)
static void	addComponents(java.util.List<? extends ModelComponent> list, int[] indices, MutableCompositeComponent<?> parent)
static void	addComponentsInReverse(java.util.List<? extends ModelComponent> list, int[] indices, java.util.List<MutableCompositeComponent<?>> parents)
static boolean	addCopyComponents(java.util.List<ModelComponent> list, ModelComponent comp)
static boolean	addCopyReferences(java.util.List<ModelComponent> list, ModelComponent comp, ModelComponent ancestor)
static boolean	areConnected(ModelComponent comp1, ModelComponent comp2) Returns true if comp2 is connected to the same component hierarchy as comp1.
static boolean	areConnectedVia(ModelComponent comp1, ModelComponent comp2, ModelComponent viacomp) Returns true if components comp1 and comp2 are connected via the component hierarchy, with the path running through the specified intermediate component viacomp (which may equal comp1, comp2, or any component on the path in between).
static CompositeComponent	castRefToAncestor(java.lang.Object ref)
static int	checkConnectivity(ModelComponent comp1, ModelComponent comp2, ModelComponent viacomp) Returns 1 if components comp1 and comp2 are connected via the component hierarchy, with the path running through the specified intermediate component viacomp (which may equal comp1, comp2, or any component on the path in between).
static void	checkReferenceContainment(ModelComponent comp)
static void	checkReferenceContainment(ModelComponent comp, CompositeComponent ancestor)
static boolean	componentsAreDeletable(java.util.Collection<? extends ModelComponent> comps, boolean ignoreEditable) Returns true if all components in a list can be deleted.
static void	deleteComponentAndDependencies(ModelComponent comp) Deletes a single component, along with all its hard dependencies, and updates its soft dependencies.
static void	deleteComponentsAndDependencies(java.util.List<? extends ModelComponent> comps) Takes a list of components and removes them along with all their hard dependencies, and updates their soft dependencies.
static CompositeComponent	farthestEncapsulatingAncestor(ModelComponent c) Returns the farthest ancestor of a component (or the component itself) for which hierarchyContainsDependencies() returns true.
static ModelComponent	findCommonAncestor(java.util.List<? extends ModelComponent> comps) Returns the common ancestor, if any, for a list of model components.
static ModelComponent	findCommonAncestor(ModelComponent comp1, ModelComponent comp2) Returns the common ancestor, if any, for two model components.
static ModelComponent	findComponent(ModelComponent comp, java.lang.String path)
static java.lang.Object	findComponentOrProperty(ModelComponent comp, java.lang.String path)
static java.util.LinkedList<ModelComponent>	findCopyComponents(java.util.List<ModelComponent> comps)
static java.util.LinkedList<ModelComponent>	findDependentComponents(java.util.List<ModelComponent> update, java.util.List<? extends ModelComponent> comps)
static Property	findProperty(ModelComponent comp, java.lang.String path)
static int	getDepth(ModelComponent comp) Returns the depth of a component within the component hierarchy.
static java.lang.String	getDiagnosticName(java.lang.Object obj) Returns name information for an object suitable for diagnostic printing.
static CompositeComponent	getGrandParent(ModelComponent comp)
static java.lang.String	getPathName(ModelComponent comp)
static java.lang.String	getPathName(ModelComponent ancestor, ModelComponent comp)
static java.lang.String	getPathName(ModelComponent reference, ModelComponent target, boolean compact) Returns a path name from a reference component to a target component.
static ModelComponent	getPropertyComponent(HasProperties host) Returns the ModelComponent, if any, associated with a given property host.
static ModelComponent	getPropertyComponent(Property prop) Returns the ModelComponent, if any, associated with a given property.
static java.lang.String	getPropertyPathName(Property prop)
static java.lang.String	getPropertyPathName(Property prop, ModelComponent topAncestor, boolean excludeLeaf)
static java.lang.String	getWritePathName(CompositeComponent ancestor, ModelComponent comp)
static java.lang.String	getWritePropertyPathName(Property prop, ModelComponent topAncestor)
static java.lang.String	getWritePropertyPathName(java.lang.String name, HasProperties host, ModelComponent topAncestor)
static boolean	haveCommonAncestor(ModelComponent comp1, ModelComponent comp2) Returns true if two components have a common ancestor.
static boolean	isAncestorOf(ModelComponent comp0, ModelComponent comp1) Returns true if comp0 is an ancestor of comp1.
static boolean	isAncestorSelected(ModelComponent comp)
static boolean	isEditable(CompositeComponent parent, boolean ignoreEditable) Returns true if a composite component is editable, meaning that its subcomponents can be removed via the GUI.
static <T extends ModelComponent> T	loadComponent(java.io.File file, CompositeComponent ancestor, java.lang.Class<T> expectedType)
static ModelComponent	loadComponent(java.lang.String fileName)
static <T extends ModelComponent> T	loadComponent(java.lang.String fileName, java.lang.Class<T> expectedType)
static ModelComponent	loadComponent(java.lang.String fileName, CompositeComponent ancestor)
static <T extends ModelComponent> T	loadComponent(java.lang.String fileName, CompositeComponent ancestor, java.lang.Class<T> expectedType)
static java.util.LinkedList<ModelComponent>	markInvalidSubcomps(ModelComponent comp) Recursively finds all subcomponents of comp which are invalid according to ClassAliases.isClassValid(java.lang.Class<?>), along with their hard dependencies, marks them to be non-writable, and returns a list of them.
static ModelComponent	maybeCopy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap, CopyableComponent c)
static ModelComponent	maybeGetCopy(int flags, java.util.Map<ModelComponent,ModelComponent> copyMap, CopyableComponent c)
static CompositeComponent	nearestEncapsulatingAncestor(ModelComponent c) Returns the closest ancestor of a component (or the component itself) for which hierarchyContainsDependencies() returns true.
static java.util.ArrayList<Property>	parseProperties(java.util.Deque<ScanToken> tokens, CompositeComponent ancestor)
static Property	parseProperty(java.lang.Object obj, CompositeComponent ancestor)
static void	recursivelyConnect(ModelComponent comp, CompositeComponent connector)
static void	recursivelyDisconnect(ModelComponent comp, CompositeComponent connector)
static <E extends ModelComponent> void	recursivelyFindComponents(java.lang.Class<E> clazz, CompositeComponent comp, java.util.List<E> out)
static boolean	referencesContained(CompositeComponent ancestor, ModelComponent comp) Returns true if all references associated with a component are recursively contained beneath a specified ancestor.
static java.util.LinkedList<MutableCompositeComponent<?>>	removeComponents(java.util.List<? extends ModelComponent> list, int[] indices)
static void	testPaths(CompositeComponent comp) Used for debugging.
static void	unmarkInvalidSubcomps(java.util.LinkedList<ModelComponent> nccomps) Sets all components in a list to be writable.
static <C extends ModelComponent> boolean	updateReferences(ModelComponent c, java.util.List<C> refs, boolean undo, java.util.Deque<java.lang.Object> undoInfo)
static boolean	withinHierarchy(ModelComponent comp, ModelComponent ancestor) Returns true if a component is equal to, or is a descendant of a particular ancestor component.
static boolean	withinHierarchy(ModelComponent comp, TransformableGeometry topObject) Returns true if a component is equal to, or is a descendant of a particular object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

componentPropertySeparator

public static final char componentPropertySeparator

See Also:

Constant Field Values

Constructor Detail

ComponentUtils

public ComponentUtils()

Method Detail

isEditable

public static boolean isEditable(CompositeComponent parent,
                                 boolean ignoreEditable)

Returns true if a composite component is editable, meaning that its subcomponents can be removed via the GUI.

Parameters:

parent - component to check for editability

ignoreEditable - if true, parent need only be an instance of MutableCompositeComponent, and the result of its MutableCompositeComponent.isEditable() method is ignored.

componentsAreDeletable

public static boolean componentsAreDeletable(java.util.Collection<? extends ModelComponent> comps,
                                             boolean ignoreEditable)

Returns true if all components in a list can be deleted.

Parameters:

comps - list of components to check

ignoreEditable - if true, each component's parent need only be an instance of MutableCompositeComponent, and the result of its MutableCompositeComponent.isEditable() method is ignored.

Returns:

true if all components can be deleted

deleteComponentAndDependencies

public static void deleteComponentAndDependencies(ModelComponent comp)

Deletes a single component, along with all its hard dependencies, and updates its soft dependencies. In some cases, it is not possible to delete certain components, in which case an exception is thrown.

The effect of this method is the same as deleting the component in the graphical interface.

Parameters:

comp - component to delete.

deleteComponentsAndDependencies

public static void deleteComponentsAndDependencies(java.util.List<? extends ModelComponent> comps)

Takes a list of components and removes them along with all their hard dependencies, and updates their soft dependencies. In some cases, it is not possible to delete certain components, in which case an exception is thrown.

The effect of this method is the same as deleting a set of components in the graphical interface.

Parameters:

comps - list of components to delete.

findDependentComponents

public static java.util.LinkedList<ModelComponent> findDependentComponents(java.util.List<ModelComponent> update,
                                                                           java.util.List<? extends ModelComponent> comps)

removeComponents

public static java.util.LinkedList<MutableCompositeComponent<?>> removeComponents(java.util.List<? extends ModelComponent> list,
                                                                                  int[] indices)

isAncestorSelected

public static boolean isAncestorSelected(ModelComponent comp)

addComponents

public static void addComponents(java.util.List<? extends ModelComponent> list,
                                 int[] indices,
                                 java.util.List<MutableCompositeComponent<?>> parents)

addComponentsInReverse

public static void addComponentsInReverse(java.util.List<? extends ModelComponent> list,
                                          int[] indices,
                                          java.util.List<MutableCompositeComponent<?>> parents)

addComponents

public static void addComponents(java.util.List<? extends ModelComponent> list,
                                 int[] indices,
                                 MutableCompositeComponent<?> parent)

addComponents

public static void addComponents(java.util.List<? extends ModelComponent> list,
                                 int[] indices,
                                 java.util.List<MutableCompositeComponent<?>> parents,
                                 boolean reverse)

withinHierarchy

public static boolean withinHierarchy(ModelComponent comp,
                                      ModelComponent ancestor)

Returns true if a component is equal to, or is a descendant of a particular ancestor component.

Parameters:

comp - component to check

ancestor - ancestor component

Returns:

true if comp is contained within the hierarchy rooted at ancestor

withinHierarchy

public static boolean withinHierarchy(ModelComponent comp,
                                      TransformableGeometry topObject)

Returns true if a component is equal to, or is a descendant of a particular object. If the object is not a ModelComponent, this method returns false.

Parameters:

comp - component to check

topObject - candidate ancestor component

Returns:

true if topObject is a ModelComponent and contains comp within its hierarchy

addCopyComponents

public static boolean addCopyComponents(java.util.List<ModelComponent> list,
                                        ModelComponent comp)

findCopyComponents

public static java.util.LinkedList<ModelComponent> findCopyComponents(java.util.List<ModelComponent> comps)

addCopyReferences

public static boolean addCopyReferences(java.util.List<ModelComponent> list,
                                        ModelComponent comp,
                                        ModelComponent ancestor)

getDepth

public static int getDepth(ModelComponent comp)

Returns the depth of a component within the component hierarchy. This equals the number of ancestor components, so a component with no parent would have a depth of 0, a component whose parent is the root would have a depth of 1, etc.

haveCommonAncestor

public static boolean haveCommonAncestor(ModelComponent comp1,
                                         ModelComponent comp2)

Returns true if two components have a common ancestor.

areConnected

public static boolean areConnected(ModelComponent comp1,
                                   ModelComponent comp2)

Returns true if comp2 is connected to the same component hierarchy as comp1.

findCommonAncestor

public static ModelComponent findCommonAncestor(ModelComponent comp1,
                                                ModelComponent comp2)

Returns the common ancestor, if any, for two model components. If there is no common ancestor, returns null. If the components are the same, then the (first) component is returned. If one component is an ancestor of the other, then that component is returned.

checkConnectivity

public static int checkConnectivity(ModelComponent comp1,
                                    ModelComponent comp2,
                                    ModelComponent viacomp)

Returns 1 if components comp1 and comp2 are connected via the component hierarchy, with the path running through the specified intermediate component viacomp (which may equal comp1, comp2, or any component on the path in between). Otherwise, return 0 if the comp1 and comp2 are not connected, or -1 if they are connected but not via viacomp.

Parameters:

comp1 - first component

comp2 - second component to which path is being checked

viacomp - required intermediate component

Returns:

1 if components are connected via a path containing viacomp, 0 if they are not connected, and -1 if they are connected by not via viacomp.

areConnectedVia

public static boolean areConnectedVia(ModelComponent comp1,
                                      ModelComponent comp2,
                                      ModelComponent viacomp)

Returns true if components comp1 and comp2 are connected via the component hierarchy, with the path running through the specified intermediate component viacomp (which may equal comp1, comp2, or any component on the path in between).

Parameters:

comp1 - first component

comp2 - second component to which path is being checked

viacomp - required intermediate component

Returns:

true if components are connected via a path containing viacomp.

findCommonAncestor

public static ModelComponent findCommonAncestor(java.util.List<? extends ModelComponent> comps)

Returns the common ancestor, if any, for a list of model components. If there is no common ancestor, returns null.

isAncestorOf

public static boolean isAncestorOf(ModelComponent comp0,
                                   ModelComponent comp1)

Returns true if comp0 is an ancestor of comp1. If comp0 is not an ancestor of comp1, or if it equals comp1, then the method returns false.

referencesContained

public static boolean referencesContained(CompositeComponent ancestor,
                                          ModelComponent comp)

Returns true if all references associated with a component are recursively contained beneath a specified ancestor.

Parameters:

ancestor - ancestor component beneath which reference should be contained

comp - component whose references should be checked

Returns:

true if all references are recursively contained below the specified ancestor

getDiagnosticName

public static java.lang.String getDiagnosticName(java.lang.Object obj)

Returns name information for an object suitable for diagnostic printing.

checkReferenceContainment

public static void checkReferenceContainment(ModelComponent comp)

checkReferenceContainment

public static void checkReferenceContainment(ModelComponent comp,
                                             CompositeComponent ancestor)

nearestEncapsulatingAncestor

public static CompositeComponent nearestEncapsulatingAncestor(ModelComponent c)

Returns the closest ancestor of a component (or the component itself) for which hierarchyContainsDependencies() returns true. That means all inter-component references are contained within the ancestor's hierarchy. If no such ancestor is found, null is returned.

Returns:

closest encapsulating ancestor

farthestEncapsulatingAncestor

public static CompositeComponent farthestEncapsulatingAncestor(ModelComponent c)

Returns the farthest ancestor of a component (or the component itself) for which hierarchyContainsDependencies() returns true. That means all inter-component references are contained within the ancestor's hierarchy. If no such ancestor is found, null is returned.

Returns:

farthest encapsulating ancestor

markInvalidSubcomps

public static java.util.LinkedList<ModelComponent> markInvalidSubcomps(ModelComponent comp)

Recursively finds all subcomponents of comp which are invalid according to ClassAliases.isClassValid(java.lang.Class<?>), along with their hard dependencies, marks them to be non-writable, and returns a list of them.

Parameters:

comp - component whose subcomponents should be checked

Returns:

non-core invalid components and their hard dependencies

unmarkInvalidSubcomps

public static void unmarkInvalidSubcomps(java.util.LinkedList<ModelComponent> nccomps)

Sets all components in a list to be writable. This undoes the effect of markInvalidSubcomps(artisynth.core.modelbase.ModelComponent).

Parameters:

nccomps - list of invalid components and their hard dependencies previously returned by markInvalidSubcomps(artisynth.core.modelbase.ModelComponent).

loadComponent

public static <T extends ModelComponent> T loadComponent(java.io.File file,
                                                         CompositeComponent ancestor,
                                                         java.lang.Class<T> expectedType)
                                                  throws java.io.IOException

Throws:

java.io.IOException

loadComponent

public static <T extends ModelComponent> T loadComponent(java.lang.String fileName,
                                                         CompositeComponent ancestor,
                                                         java.lang.Class<T> expectedType)
                                                  throws java.io.IOException

Throws:

java.io.IOException

loadComponent

public static <T extends ModelComponent> T loadComponent(java.lang.String fileName,
                                                         java.lang.Class<T> expectedType)
                                                  throws java.io.IOException

Throws:

java.io.IOException

loadComponent

public static ModelComponent loadComponent(java.lang.String fileName,
                                           CompositeComponent ancestor)
                                    throws java.io.IOException

Throws:

java.io.IOException

loadComponent

public static ModelComponent loadComponent(java.lang.String fileName)
                                    throws java.io.IOException

Throws:

java.io.IOException

getPropertyComponent

public static ModelComponent getPropertyComponent(Property prop)

Returns the ModelComponent, if any, associated with a given property.

Parameters:

prop - property to be queried

Returns:

model component associated with the property

getPropertyComponent

public static ModelComponent getPropertyComponent(HasProperties host)

Returns the ModelComponent, if any, associated with a given property host.

Parameters:

host - property host to be queried

Returns:

model component associated with the host

findComponent

public static ModelComponent findComponent(ModelComponent comp,
                                           java.lang.String path)

findProperty

public static Property findProperty(ModelComponent comp,
                                    java.lang.String path)

findComponentOrProperty

public static java.lang.Object findComponentOrProperty(ModelComponent comp,
                                                       java.lang.String path)

parseProperty

public static Property parseProperty(java.lang.Object obj,
                                     CompositeComponent ancestor)
                              throws java.io.IOException

Throws:

java.io.IOException

parseProperties

public static java.util.ArrayList<Property> parseProperties(java.util.Deque<ScanToken> tokens,
                                                            CompositeComponent ancestor)
                                                     throws java.io.IOException

Throws:

java.io.IOException

getPathName

public static java.lang.String getPathName(ModelComponent comp)

getPathName

public static java.lang.String getPathName(ModelComponent ancestor,
                                           ModelComponent comp)

getPathName

public static java.lang.String getPathName(ModelComponent reference,
                                           ModelComponent target,
                                           boolean compact)

Returns a path name from a reference component to a target component. The reference does not need to be an ancestor of the target.

getWritePropertyPathName

public static java.lang.String getWritePropertyPathName(Property prop,
                                                        ModelComponent topAncestor)

getWritePropertyPathName

public static java.lang.String getWritePropertyPathName(java.lang.String name,
                                                        HasProperties host,
                                                        ModelComponent topAncestor)

getPropertyPathName

public static java.lang.String getPropertyPathName(Property prop,
                                                   ModelComponent topAncestor,
                                                   boolean excludeLeaf)

getPropertyPathName

public static java.lang.String getPropertyPathName(Property prop)

getGrandParent

public static CompositeComponent getGrandParent(ModelComponent comp)

maybeGetCopy

public static ModelComponent maybeGetCopy(int flags,
                                          java.util.Map<ModelComponent,ModelComponent> copyMap,
                                          CopyableComponent c)

maybeCopy

public static ModelComponent maybeCopy(int flags,
                                       java.util.Map<ModelComponent,ModelComponent> copyMap,
                                       CopyableComponent c)

recursivelyFindComponents

public static <E extends ModelComponent> void recursivelyFindComponents(java.lang.Class<E> clazz,
                                                                        CompositeComponent comp,
                                                                        java.util.List<E> out)

getWritePathName

public static java.lang.String getWritePathName(CompositeComponent ancestor,
                                                ModelComponent comp)

testPaths

public static void testPaths(CompositeComponent comp)

Used for debugging. Recursively make sure that every descendent component of this CompositeComponent has a valid path name.

castRefToAncestor

public static CompositeComponent castRefToAncestor(java.lang.Object ref)
                                            throws java.io.IOException

Throws:

java.io.IOException

updateReferences

public static <C extends ModelComponent> boolean updateReferences(ModelComponent c,
                                                                  java.util.List<C> refs,
                                                                  boolean undo,
                                                                  java.util.Deque<java.lang.Object> undoInfo)

recursivelyConnect

public static void recursivelyConnect(ModelComponent comp,
                                      CompositeComponent connector)

recursivelyDisconnect

public static void recursivelyDisconnect(ModelComponent comp,
                                         CompositeComponent connector)