artisynth.core.modelbase

Class TransformGeometryContext

java.lang.Object

artisynth.core.modelbase.TransformGeometryContext

public class TransformGeometryContext
extends java.lang.Object

Manages the geometry transformation for a set of transformable components. Maintains a set of all the components being transformed, along with actions that should be called after their TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) methods have been called. The transform operation is carried out by the context's apply(maspack.geometry.GeometryTransformer, int) method.

Field Summary

Fields

Modifier and Type	Field and Description
static int	IS_TRANSFORMED

Constructor Summary

Constructors

Constructor and Description
TransformGeometryContext() Creates a new TransformGeometryContext.
TransformGeometryContext(java.lang.Iterable<? extends TransformableGeometry> tgens) Creates a new TransformGeometryContext and adds a set of transformable components to it.
TransformGeometryContext(TransformableGeometry tg) Creates a new TransformGeometryContext and adds a single transformable component to it.
TransformGeometryContext(TransformableGeometry[] tgens) Creates a new TransformGeometryContext and adds a set of transformable components to it.

Method Summary

Modifier and Type	Method and Description
void	add(TransformableGeometry tg) Adds a transformable component to this context.
void	add(TransformableGeometry tg, int flags) Adds a transformable component to this context, with the specified flags settings.
void	addAction(TransformGeometryAction action) Adds an action to be called within the apply(maspack.geometry.GeometryTransformer, int) method after the TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) methods have been called for all the transformables.
void	addAll(java.util.Collection<? extends TransformableGeometry> tgens) Adds a set of transformable components to this context.
void	addParentToNotify(CompositeComponent comp) Adds a parent component to be notified of the change in geometry using a GeometryChangeEvent.
void	addTransformableDescendants(CompositeComponent comp, int flags) Adds transformable descendants of a composite component to this context.
boolean	allTransformed(java.util.Collection<? extends TransformableGeometry> tgens) Returns true if all members of a specified set of transformable components are marked as having been transformed.
boolean	allTransformed(TransformableGeometry[] tgens) Returns true if all members of a specified set of transformable components are marked as having been transformed.
void	apply(GeometryTransformer gtr, int flags) Applies a geometry transformation to all the transformable components currently stored in this context.
boolean	contains(TransformableGeometry tg) Returns true if a specified transformable component is contained in this context.
boolean	containsAction(TransformGeometryAction action) Returns true if this context contains the specified action.
boolean	containsAll(java.lang.Iterable<? extends TransformableGeometry> tgens) Returns true if all members of a set of transformable components are contained in this context.
boolean	containsAll(TransformableGeometry[] tgens) Returns true if all members of a set of transformable components are contained in this context.
boolean	containsAny(java.lang.Iterable<? extends TransformableGeometry> tgens) Returns true if any member of a set of transformable components is contained in this context.
boolean	containsAny(TransformableGeometry[] tgens) Returns true if any member of a set of transformable components is contained in this context.
boolean	containsParentToNotify(CompositeComponent comp) Returns true if this context contains the specified parent component to notified of the change in geometry.
java.util.Set<TransformableGeometry>	getTransformables() Returns a set view of all the transformable components contained in this context.
boolean	isTransformed(TransformableGeometry tg) Returns true if a specified transformable component is marked as having been transformed.
void	markTransformed(TransformableGeometry tg) Mark a specified transformable component as having been transformed.
int	numTransformables() Returns the number of transformable components in this context.
static void	transform(java.lang.Iterable<TransformableGeometry> tgens, AffineTransform3dBase X, int flags) Applies a rigid or affine transform to a specified set of transformable components.
static void	transform(java.lang.Iterable<TransformableGeometry> tgens, GeometryTransformer gtr, int flags) Applies a geometry transform to a specified set of transformable components.
static void	transform(TransformableGeometry[] tgens, AffineTransform3dBase X, int flags) Applies a rigid or affine transform to a specified set of transformable components.
static void	transform(TransformableGeometry[] tgens, GeometryTransformer gtr, int flags) Applies a geometry transform to a specified set of transformable components.
static void	transform(TransformableGeometry tg, AffineTransform3dBase X, int flags) Applies a rigid or affine transform to a specified transformable component.
static void	transform(TransformableGeometry tg, GeometryTransformer gtr, int flags) Applies a geometry transform to a specified transformable component.

Methods inherited from class java.lang.Object

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

Field Detail

IS_TRANSFORMED

public static final int IS_TRANSFORMED

See Also:

Constant Field Values

Constructor Detail

TransformGeometryContext

public TransformGeometryContext()

Creates a new TransformGeometryContext.

TransformGeometryContext

public TransformGeometryContext(TransformableGeometry tg)

Creates a new TransformGeometryContext and adds a single transformable component to it.

Parameters:

tg - transformable component to add

TransformGeometryContext

public TransformGeometryContext(java.lang.Iterable<? extends TransformableGeometry> tgens)

Creates a new TransformGeometryContext and adds a set of transformable components to it.

Parameters:

tgens - transformable components to add

TransformGeometryContext

public TransformGeometryContext(TransformableGeometry[] tgens)

Creates a new TransformGeometryContext and adds a set of transformable components to it.

Parameters:

tgens - transformable components to add

Method Detail

add

public void add(TransformableGeometry tg)

Adds a transformable component to this context. Components are stored as a set, so the same component cannot be added twice.

Parameters:

tg - transformable component to add

add

public void add(TransformableGeometry tg,
                int flags)

Adds a transformable component to this context, with the specified flags settings.

Parameters:

tg - transformable component to add

flags - flag settings for the component

See Also:

add(TransformableGeometry)

addAll

public void addAll(java.util.Collection<? extends TransformableGeometry> tgens)

Adds a set of transformable components to this context.

Parameters:

tgens - transformable components to add

See Also:

add(TransformableGeometry)

contains

public boolean contains(TransformableGeometry tg)

Returns true if a specified transformable component is contained in this context.

Parameters:

tg - transformable component to check

Returns:

true if tg is contained in this context.

containsAll

public boolean containsAll(java.lang.Iterable<? extends TransformableGeometry> tgens)

Returns true if all members of a set of transformable components are contained in this context.

Parameters:

tgens - transformable components to check

Returns:

true if all components are contained in this context.

containsAll

public boolean containsAll(TransformableGeometry[] tgens)

Returns true if all members of a set of transformable components are contained in this context.

Parameters:

tgens - transformable components to check

Returns:

true if all components are contained in this context.

getTransformables

public java.util.Set<TransformableGeometry> getTransformables()

Returns a set view of all the transformable components contained in this context.

Returns:

all transformables in this context.

containsAny

public boolean containsAny(java.lang.Iterable<? extends TransformableGeometry> tgens)

Returns true if any member of a set of transformable components is contained in this context.

Parameters:

tgens - transformable components to check

Returns:

true if any of the components are contained in this context.

containsAny

public boolean containsAny(TransformableGeometry[] tgens)

Returns true if any member of a set of transformable components is contained in this context.

Parameters:

tgens - transformable components to check

Returns:

true if any of the components are contained in this context.

numTransformables

public int numTransformables()

Returns the number of transformable components in this context.

Returns:

number of transformable components.

isTransformed

public boolean isTransformed(TransformableGeometry tg)

Returns true if a specified transformable component is marked as having been transformed. Components are automatically marked as having been transformed after their TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) method is called within this context's apply(maspack.geometry.GeometryTransformer, int) method. Components can also be marked as being transformed using markTransformed(artisynth.core.modelbase.TransformableGeometry). The apply(maspack.geometry.GeometryTransformer, int) method will not call the TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) method for any component which is already marked as transformed.

Parameters:

tg - component to check

Returns:

true if tg is marked as transformed

markTransformed

public void markTransformed(TransformableGeometry tg)

Mark a specified transformable component as having been transformed.

Parameters:

tg - component to mark as transformed

allTransformed

public boolean allTransformed(java.util.Collection<? extends TransformableGeometry> tgens)

Returns true if all members of a specified set of transformable components are marked as having been transformed. For more information on what this means, see isTransformed(artisynth.core.modelbase.TransformableGeometry).

Parameters:

tgens - components to check

Returns:

true if all components are marked as transformed

allTransformed

public boolean allTransformed(TransformableGeometry[] tgens)

Returns true if all members of a specified set of transformable components are marked as having been transformed. For more information on what this means, see isTransformed(artisynth.core.modelbase.TransformableGeometry).

Parameters:

tgens - components to check

Returns:

true if all components are marked as transformed

addAction

public void addAction(TransformGeometryAction action)

Adds an action to be called within the apply(maspack.geometry.GeometryTransformer, int) method after the TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) methods have been called for all the transformables. Actions are stored as a set, so the same action can only be added once.

Parameters:

action - action to be called after all transformGeometry methods.

containsAction

public boolean containsAction(TransformGeometryAction action)

Returns true if this context contains the specified action.

Parameters:

action - action to be checked

Returns:

true if this context contains action

addParentToNotify

public void addParentToNotify(CompositeComponent comp)

Adds a parent component to be notified of the change in geometry using a GeometryChangeEvent. More information about when the notification occurs is contained in the documentation for the apply(maspack.geometry.GeometryTransformer, int) method. Parents to be notified are stored as a set, and so cannot be added twice.

Parameters:

comp - parent component to be notified

containsParentToNotify

public boolean containsParentToNotify(CompositeComponent comp)

Returns true if this context contains the specified parent component to notified of the change in geometry.

Parameters:

comp - component to be tested

Returns:

true if comp is contained in this context

apply

public void apply(GeometryTransformer gtr,
                  int flags)

Applies a geometry transformation to all the transformable components currently stored in this context. This involves the following steps:

• Call TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int) for each transformable to add additional components that need to be transformed, such as descendants or certain connected components.
• Call TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) for each transformable, and then use markTransformed(artisynth.core.modelbase.TransformableGeometry) to mark that component as being transformed. The call is skipped for components that have already been marked as being transformed. This gives the components some ability to control the transform process: within the transformGeometry method for component A, it may be desirable to call the transformGeometry method for another component B directly. Component A may do so, and then mark B as being transformed.
• Send a GeometryChangeEvent to any parent components for which notification was requested (using addParentToNotify(artisynth.core.modelbase.CompositeComponent)) during step 2.
• Call the TransformGeometryAction.transformGeometry(maspack.geometry.GeometryTransformer, artisynth.core.modelbase.TransformGeometryContext, int) method of any actions that were requested ( using addAction(artisynth.core.modelbase.TransformGeometryAction)) by the transformGeometry methods called during step 2. The actions themselves may request additional actions; the process will continue until all actions have been called.
• Send a GeometryChangeEvent to all the parents of the transformable components, along with any additional parent components for which notification was requested during step 4.

Parameters:

gtr - transformation to apply

flags - specifies conditions associated with the transformation

addTransformableDescendants

public void addTransformableDescendants(CompositeComponent comp,
                                        int flags)

Adds transformable descendants of a composite component to this context. The method searches recursively for transformable components among the descendants of comp. When a transformable is found, it is added to this context, and its TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int) method is called to add any dependencies of that component to this context.

Parameters:

comp - component for which transformable descendants should be added

flags - specifies conditions associated with the transformation

transform

public static void transform(TransformableGeometry tg,
                             GeometryTransformer gtr,
                             int flags)

Applies a geometry transform to a specified transformable component. A context is created for the component and its apply(maspack.geometry.GeometryTransformer, int) method is called.

Parameters:

tg - component to transform

gtr - transformer to effect the transformation

flags - specifies conditions associated with the transformation

transform

public static void transform(java.lang.Iterable<TransformableGeometry> tgens,
                             GeometryTransformer gtr,
                             int flags)

Applies a geometry transform to a specified set of transformable components. A context is created for the component and its apply(maspack.geometry.GeometryTransformer, int) method is called.

Parameters:

tgens - components to transform

gtr - transformer to effect the transformation

flags - specifies conditions associated with the transformation

transform

public static void transform(TransformableGeometry[] tgens,
                             GeometryTransformer gtr,
                             int flags)

Applies a geometry transform to a specified set of transformable components. A context is created for the component and its apply(maspack.geometry.GeometryTransformer, int) method is called.

Parameters:

tgens - components to transform

gtr - transformer to effect the transformation

flags - specifies conditions associated with the transformation

transform

public static void transform(TransformableGeometry tg,
                             AffineTransform3dBase X,
                             int flags)

Applies a rigid or affine transform to a specified transformable component. A context is created for the component and its apply(maspack.geometry.GeometryTransformer, int) method is called using a transformer created for X.

Parameters:

tg - component to transform

X - rigid or affine transform (used to create the transformer)

flags - specifies conditions associated with the transformation

transform

public static void transform(java.lang.Iterable<TransformableGeometry> tgens,
                             AffineTransform3dBase X,
                             int flags)

Applies a rigid or affine transform to a specified set of transformable components. A context is created for the components and its apply(maspack.geometry.GeometryTransformer, int) method is called using a transformer created for X.

Parameters:

tgens - components to transform

X - rigid or affine transform (used to create the transformer)

flags - specifies conditions associated with the transformation

transform

public static void transform(TransformableGeometry[] tgens,
                             AffineTransform3dBase X,
                             int flags)

Applies a rigid or affine transform to a specified set of transformable components. A context is created for the components and its apply(maspack.geometry.GeometryTransformer, int) method is called using a transformer created for X.

Parameters:

tgens - components to transform

X - rigid or affine transform (used to create the transformer)

flags - specifies conditions associated with the transformation