artisynth.core.renderables

Class GridPlane

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.renderables.GridPlane

All Implemented Interfaces:

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

public class GridPlane
extends RenderableComponentBase

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 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
GridPlane(RigidTransform3d trans, Vector2d size, Vector2d resolution)

Method Summary

Modifier and Type	Method and Description
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
static RenderProps	defaultRenderProps(GridPlane comp)
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
AxisAngle	getOrientation() Gets the orientation of the display
Point3d	getPosition() Gets the 3D position of the centre of the display
Vector2d	getResolution() Gets the resolution of the display, integers (nx,ny) corresponding to the number of divisions along the x and y axes
Vector2d	getSize() Gets the size of the display grid
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setGridToWorld(RigidTransform3d X) Sets the transform between the display grid and World
void	setOrientation(AxisAngle axisAng) Sets the orientation of the display
void	setPosition(Point3d pos) Sets the 3D position of the centre of the display
void	setResolution(Vector2d res) Sets the resolution fo teh display, integers (nx, ny) corresponding to the number of divisions along the x and y axes.
void	setSize(Vector2d size) Sets the size of the display grid
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, getSelection, isSelectable, isVisible, numSelectionQueriesNeeded, prerender, 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

myProps

public static PropertyList myProps

Constructor Detail

GridPlane

public GridPlane(RigidTransform3d trans,
                 Vector2d size,
                 Vector2d resolution)

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

defaultRenderProps

public static RenderProps defaultRenderProps(GridPlane comp)

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.

getSize

public Vector2d getSize()

Gets the size of the display grid

setSize

public void setSize(Vector2d size)

Sets the size of the display grid

getResolution

public Vector2d getResolution()

Gets the resolution of the display, integers (nx,ny) corresponding to the number of divisions along the x and y axes

setResolution

public void setResolution(Vector2d res)

Sets the resolution fo teh display, integers (nx, ny) corresponding to the number of divisions along the x and y axes. This triggers a rebuild of the mesh.

getPosition

public Point3d getPosition()

Gets the 3D position of the centre of the display

setPosition

public void setPosition(Point3d pos)

Sets the 3D position of the centre of the display

getOrientation

public AxisAngle getOrientation()

Gets the orientation of the display

setOrientation

public void setOrientation(AxisAngle axisAng)

Sets the orientation of the display

setGridToWorld

public void setGridToWorld(RigidTransform3d X)

Sets the transform between the display grid and World

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