artisynth.core.renderables

Class Spline3dBody

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.renderables.Spline3dBody

All Implemented Interfaces:

HasCoordinateFrame, IsLineComponent, LineIntersectable, ModelComponent, PostScannable, RenderableComponent, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

public class Spline3dBody
extends RenderableComponentBase
implements HasCoordinateFrame, IsLineComponent, LineIntersectable

Custom component that contains and renders a 3D cubic Hermite spline.

Nested Class Summary

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

ModelComponent.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NUM_RENDER_POINTS
static double	INF
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
Spline3dBody()
Spline3dBody(CubicHermiteSpline3d spline)
Spline3dBody(java.lang.String name, CubicHermiteSpline3d spline)

Method Summary

Modifier and Type	Method and Description
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
int	getNumRenderPoints()
AxisAngle	getOrientation()
RigidTransform3d	getPose()
void	getPose(RigidTransform3d XFrameToWorld)
Point3d	getPosition()
Quaternion	getRotation()
void	getSelection(java.util.LinkedList<java.lang.Object> list, int qid) Append to list the component (or components) associated with the qid-th selection query issued by this component's render method.
CubicHermiteSpline3d	getSpline()
artisynth.core.renderables.Spline3dBody.SplineBodyPosition	nearestPointToLine(Line line) Returns the point on this object which is nearest to the specified line.
void	prerender(RenderList list) Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setNumRenderPoints(int num)
void	setOrientation(AxisAngle axisAng)
void	setPose(RigidTransform3d XFrameToWorld)
void	setPosition(Point3d pos)
void	setRotation(Quaternion q)
void	updateBounds(Vector3d pmin, Vector3d pmax) Update the minimum and maximum points for this object.

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

copy, defaultRenderPropsAreNull, getRenderHints, getRenderProps, isSelectable, isVisible, numSelectionQueriesNeeded, setRenderProps, setVisible, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, hasState, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, updateReferences, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

INF

public static final double INF

See Also:

Constant Field Values

DEFAULT_NUM_RENDER_POINTS

public static int DEFAULT_NUM_RENDER_POINTS

myProps

public static PropertyList myProps

Constructor Detail

Spline3dBody

public Spline3dBody()

Spline3dBody

public Spline3dBody(CubicHermiteSpline3d spline)

Spline3dBody

public Spline3dBody(java.lang.String name,
                    CubicHermiteSpline3d spline)

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Overrides:

getAllPropertyInfo in class RenderableComponentBase

Returns:

static information for all exported properties

getSpline

public CubicHermiteSpline3d getSpline()

getNumRenderPoints

public int getNumRenderPoints()

setNumRenderPoints

public void setNumRenderPoints(int num)

setPose

public void setPose(RigidTransform3d XFrameToWorld)

getPose

public RigidTransform3d getPose()

getPose

public void getPose(RigidTransform3d XFrameToWorld)

Specified by:

getPose in interface HasCoordinateFrame

getPosition

public Point3d getPosition()

setPosition

public void setPosition(Point3d pos)

getOrientation

public AxisAngle getOrientation()

setOrientation

public void setOrientation(AxisAngle axisAng)

getRotation

public Quaternion getRotation()

setRotation

public void setRotation(Quaternion q)

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface HasRenderProps

Overrides:

createRenderProps in class RenderableComponentBase

Returns:

new render properties for this object

render

public void render(Renderer renderer,
                   int flags)

Description copied from interface: IsRenderable

Render this object using the functionality of the supplied Renderer.

Specified by:

render in interface IsRenderable

Specified by:

render in class RenderableComponentBase

Parameters:

renderer - provides the functionality used to perform the rendering.

flags - flags that may be used to control different aspects of the rendering. Flags are defined in Renderer and currently include Renderer.HIGHLIGHT and Renderer.SORT_FACES.

prerender

public void prerender(RenderList list)

Description copied from interface: IsRenderable

Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling

list.addIfVisible (obj);

for each of the objects in question.

Specified by:

prerender in interface IsRenderable

Overrides:

prerender in class RenderableComponentBase

Parameters:

list - list of objects to be rendered

getSelection

public void getSelection(java.util.LinkedList<java.lang.Object> list,
                         int qid)

Description copied from interface: IsSelectable

Append to list the component (or components) associated with the qid-th selection query issued by this component's render method. This will only be called if this component manages its own selection (i.e., the number nums returned by IsSelectable.numSelectionQueriesNeeded() is positive), and qid will in turn be a number between 0 and nums-1.

Specified by:

getSelection in interface IsSelectable

Overrides:

getSelection in class RenderableComponentBase

Parameters:

list - selected objects are appended to the end of this list

qid - index of the selection query

updateBounds

public void updateBounds(Vector3d pmin,
                         Vector3d pmax)

Description copied from interface: IsRenderable

Update the minimum and maximum points for this object. In an x-y-z coordinate system with x directed to the right and y directed upwards, the minimum and maximum points can be thought of as defining the left-lower-far and right-upper-near corners of a bounding cube. This method should only reduce the elements of the minimum point and increase the elements of the maximum point, since it may be used as part of an iteration to determine the bounding cube for several different objects.

Specified by:

updateBounds in interface IsRenderable

Overrides:

updateBounds in class RenderableComponentBase

Parameters:

pmin - minimum point

pmax - maximum point

nearestPointToLine

public artisynth.core.renderables.Spline3dBody.SplineBodyPosition nearestPointToLine(Line line)

Returns the point on this object which is nearest to the specified line. The point is described by a HasPosition object which is attached to the object and moves with it.

Specified by:

nearestPointToLine in interface LineIntersectable

Parameters:

line - line to which nearest point is to be computed

Returns:

nearest point to the line