GridPlane (Artisynth API documentation)

java.lang.Object
- maspack.render.GridPlane

All Implemented Interfaces:: HasProperties

Direct Known Subclasses:: GLClipPlane

public class GridPlane
extends java.lang.Object
implements HasProperties

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GridPlane.AxisLabeling

Nested Classes
Modifier and Type	Class and Description
`static class`	`GridPlane.AxisLabeling`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.awt.Color`	`DEFAULT_LABEL_COLOR`
`static double`	`DEFAULT_LABEL_SIZE`
`static boolean`	`DEFAULT_LOCK_AXES_TO_WORLD`
`static boolean`	`DEFAULT_USE_WORLD_ORIGIN`
`static GridPlane.AxisLabeling`	`DEFAULT_X_AXIS_LABELING`
`static GridPlane.AxisLabeling`	`DEFAULT_Y_AXIS_LABELING`
`static PropertyList`	`myProps`

Constructor Summary

Constructors
Constructor and Description

GridPlane()

Constructors
Constructor and Description
`GridPlane()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`alignPoint(Vector3d aligned, Vector3d pnt)` Aligns a point with the nearest point defined by this grid.
`void`	`centerInViewer()`
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`int`	`getCellDivisions()` Returns the number of subdivisions for each cell.
`double`	`getCellSize()` Returns the cell size for this grid.
`Dragger3d.DraggerType`	`getDragger()`
`RigidTransform3d`	`getGridToWorld()`
`void`	`getGridToWorld(RigidTransform3d X)`
`java.awt.Color`	`getLabelColor()`
`double`	`getLabelSize()`
`int`	`getLineWidth()` Returns the line width used to render this grid.
`boolean`	`getLockAxesToWorld()`
`java.awt.Color`	`getMajorColor()`
`int`	`getMinCellPixels()` Returns the desired minimum number of pixels per cell or divided cell.
`java.awt.Color`	`getMinorColor()`
`double`	`getMinSize()`
`AxisAngle`	`getOrientation()`
`Plane`	`getPlane()`
`void`	`getPlane(Plane plane)`
`void`	`getPlaneValues(double[] vals)`
`int`	`getPlaneValues(float[] vals, int offset)`
`Point3d`	`getPosition()`
`Property`	`getProperty(java.lang.String name)` Returns a property associated with a specified path name.
`GridResolution`	`getResolution()` Retuns the resolution for this grid.
`boolean`	`getUseWorldOrigin()`
`GLViewer`	`getViewer()`
`java.awt.Color`	`getXAxisColor()`
`GridPlane.AxisLabeling`	`getXAxisLabeling()`
`java.awt.Color`	`getYAxisColor()`
`GridPlane.AxisLabeling`	`getYAxisLabeling()`
`java.awt.Color`	`getZAxisColor()`
`boolean`	`isAutoSized()` Returns true is cell sizes for this grid are computed automatically.
`boolean`	`isGridVisible()`
`static void`	`main(java.lang.String[] args)`
`int`	`numCellDivisions()` Returns the number of subdivisions for each cell.
`void`	`render(Renderer renderer, int flags)`
`void`	`resetInViewer()`
`void`	`setAutoSized(boolean enable)` Enables or disables auto cell sizing for this grid.
`void`	`setDragger(Dragger3d.DraggerType type)`
`void`	`setGridToWorld(RigidTransform3d TGW)`
`void`	`setGridVisible(boolean enable)`
`void`	`setLabelColor(java.awt.Color color)`
`void`	`setLabelSize(double emSize)`
`void`	`setLineWidth(int width)` Sets the line width used to render this grid.
`void`	`setLockAxesToWorld(boolean enable)`
`void`	`setMajorColor(java.awt.Color color)`
`void`	`setMinCellPixels(int n)` Sets the desired minimum number of pixels per cell or divided cell.
`void`	`setMinorColor(java.awt.Color color)`
`double`	`setMinSize(double size)` Sets the minimum grid size.
`void`	`setOrientation(AxisAngle axisAng)`
`void`	`setPosition(Point3d pos)`
`void`	`setResolution(double majorCellSize, int numDivisions)` Sets the resolution for this grid.
`void`	`setResolution(GridResolution res)` Sets the resolution for this grid.
`void`	`setUseWorldOrigin(boolean enable)`
`void`	`setViewer(GLViewer viewer)`
`void`	`setXAxisColor(java.awt.Color color)`
`void`	`setXAxisLabeling(GridPlane.AxisLabeling labeling)`
`void`	`setYAxisColor(java.awt.Color color)`
`void`	`setYAxisLabeling(GridPlane.AxisLabeling labeling)`
`void`	`setZAxisColor(java.awt.Color color)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOCK_AXES_TO_WORLD
```
public static boolean DEFAULT_LOCK_AXES_TO_WORLD
```
  - DEFAULT_USE_WORLD_ORIGIN
```
public static boolean DEFAULT_USE_WORLD_ORIGIN
```
  - DEFAULT_X_AXIS_LABELING
```
public static GridPlane.AxisLabeling DEFAULT_X_AXIS_LABELING
```
  - DEFAULT_Y_AXIS_LABELING
```
public static GridPlane.AxisLabeling DEFAULT_Y_AXIS_LABELING
```
  - DEFAULT_LABEL_SIZE
```
public static double DEFAULT_LABEL_SIZE
```
  - DEFAULT_LABEL_COLOR
```
public static final java.awt.Color DEFAULT_LABEL_COLOR
```
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - GridPlane
```
public GridPlane()
```
- 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
    
    Returns:
    
    static information for all exported properties
  - getProperty
```
public Property getProperty(java.lang.String name)
```
    Returns a property associated with a specified path name. All properties exported by this object must have a name which is a valid Java identifier. Specifying one of these names causes the corresponding Property to be returned. Handles to subproperties can also be obtained by delimiting the sub-property name(s) by '.' characters. A sub-property exists if the value of a property is itself an object which exports properties. It is only possible to obtain a sub-property handle if each of its ancestor properties exports their values by reference.
    
    Specified by:
    
    getProperty in interface HasProperties
    
    Parameters:
    
    name - name of the desired property or sub-property
    
    Returns:
    
    handle to the property
  - getMinCellPixels
```
public int getMinCellPixels()
```
    Returns the desired minimum number of pixels per cell or divided cell.
    
    Returns:
    
    minimum pixels for each cell or divided cell
  - setMinCellPixels
```
public void setMinCellPixels(int n)
```
    Sets the desired minimum number of pixels per cell or divided cell. This is used when automatically computing cell sizes and/or divisions.
    
    Parameters:
    
    n - minimum pixels for each cell or divided cell
  - getCellSize
```
public double getCellSize()
```
    Returns the cell size for this grid. If auto cell sizing is enabled, this value is computed automatically.
    
    Returns:
    
    size grid cell size
  - setLineWidth
```
public void setLineWidth(int width)
```
    Sets the line width used to render this grid.
    
    Parameters:
    
    width - new line width
  - getLineWidth
```
public int getLineWidth()
```
    Returns the line width used to render this grid.
    
    Returns:
    
    line width
  - getLockAxesToWorld
```
public boolean getLockAxesToWorld()
```
  - setLockAxesToWorld
```
public void setLockAxesToWorld(boolean enable)
```
  - getPosition
```
public Point3d getPosition()
```
  - setPosition
```
public void setPosition(Point3d pos)
```
  - getOrientation
```
public AxisAngle getOrientation()
```
  - setOrientation
```
public void setOrientation(AxisAngle axisAng)
```
  - setResolution
```
public void setResolution(double majorCellSize,
                          int numDivisions)
```
    Sets the resolution for this grid.
    If the major cell size is 0, then auto-sizing will be enabled and the grid size will be computed automatically, based on the viewer's current zoom level. Otherwise, auto-sizing will be turned off.
    
    Parameters:
    
    majorCellSize - major cell size
    
    numDivisions - number of divisions per cell
  - setResolution
```
public void setResolution(GridResolution res)
```
    Sets the resolution for this grid. The resolution res specifies the major cell size and the number of subdivisions per cell.
    If the major cell size is 0, then auto-sizing will be enabled and the grid size will be computed automatically, based on the viewer's current zoom level. Otherwise, auto-sizing will be turned off.
    
    Parameters:
    
    res - specified new grid resolution, or auto-sizing.
  - getResolution
```
public GridResolution getResolution()
```
    Retuns the resolution for this grid.
    
    Returns:
    
    grid resolution
  - isAutoSized
```
public boolean isAutoSized()
```
    Returns true is cell sizes for this grid are computed automatically.
    
    Returns:
    
    true is auto cell sizing is enabled
  - setAutoSized
```
public void setAutoSized(boolean enable)
```
    Enables or disables auto cell sizing for this grid.
    
    Parameters:
    
    enable - if true, enables auto cell sizing
  - numCellDivisions
```
public int numCellDivisions()
```
    Returns the number of subdivisions for each cell. If auto cell dividing is enabled, this value is computed automatically.
    
    Returns:
    
    number of cell subdivisions
  - getCellDivisions
```
public int getCellDivisions()
```
    Returns the number of subdivisions for each cell.
    
    Returns:
    
    number of cell subdivisions
  - setMinSize
```
public double setMinSize(double size)
```
    Sets the minimum grid size.
  - getMinSize
```
public double getMinSize()
```
  - getGridToWorld
```
public RigidTransform3d getGridToWorld()
```
  - alignPoint
```
public void alignPoint(Vector3d aligned,
                       Vector3d pnt)
```
    Aligns a point with the nearest point defined by this grid. Both the original and aligned points are described in grid coordinates.
  - setGridToWorld
```
public void setGridToWorld(RigidTransform3d TGW)
```
  - getGridToWorld
```
public void getGridToWorld(RigidTransform3d X)
```
  - setViewer
```
public void setViewer(GLViewer viewer)
```
  - getViewer
```
public GLViewer getViewer()
```
  - getDragger
```
public Dragger3d.DraggerType getDragger()
```
  - setDragger
```
public void setDragger(Dragger3d.DraggerType type)
```
  - isGridVisible
```
public boolean isGridVisible()
```
  - setGridVisible
```
public void setGridVisible(boolean enable)
```
  - render
```
public void render(Renderer renderer,
                   int flags)
```
  - getPlane
```
public void getPlane(Plane plane)
```
  - getPlane
```
public Plane getPlane()
```
  - getPlaneValues
```
public void getPlaneValues(double[] vals)
```
  - getPlaneValues
```
public int getPlaneValues(float[] vals,
                          int offset)
```
  - centerInViewer
```
public void centerInViewer()
```
  - resetInViewer
```
public void resetInViewer()
```
  - getMajorColor
```
public java.awt.Color getMajorColor()
```
  - setMajorColor
```
public void setMajorColor(java.awt.Color color)
```
  - getUseWorldOrigin
```
public boolean getUseWorldOrigin()
```
  - setUseWorldOrigin
```
public void setUseWorldOrigin(boolean enable)
```
  - getXAxisLabeling
```
public GridPlane.AxisLabeling getXAxisLabeling()
```
  - setXAxisLabeling
```
public void setXAxisLabeling(GridPlane.AxisLabeling labeling)
```
  - getYAxisLabeling
```
public GridPlane.AxisLabeling getYAxisLabeling()
```
  - setYAxisLabeling
```
public void setYAxisLabeling(GridPlane.AxisLabeling labeling)
```
  - setLabelSize
```
public void setLabelSize(double emSize)
```
  - getLabelSize
```
public double getLabelSize()
```
  - setLabelColor
```
public void setLabelColor(java.awt.Color color)
```
  - getLabelColor
```
public java.awt.Color getLabelColor()
```
  - getXAxisColor
```
public java.awt.Color getXAxisColor()
```
  - setXAxisColor
```
public void setXAxisColor(java.awt.Color color)
```
  - getYAxisColor
```
public java.awt.Color getYAxisColor()
```
  - setYAxisColor
```
public void setYAxisColor(java.awt.Color color)
```
  - getZAxisColor
```
public java.awt.Color getZAxisColor()
```
  - setZAxisColor
```
public void setZAxisColor(java.awt.Color color)
```
  - getMinorColor
```
public java.awt.Color getMinorColor()
```
  - setMinorColor
```
public void setMinorColor(java.awt.Color color)
```
  - main
```
public static void main(java.lang.String[] args)
```

Class GridPlane

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOCK_AXES_TO_WORLD

DEFAULT_USE_WORLD_ORIGIN

DEFAULT_X_AXIS_LABELING

DEFAULT_Y_AXIS_LABELING

DEFAULT_LABEL_SIZE

DEFAULT_LABEL_COLOR

myProps

Constructor Detail

GridPlane

Method Detail

getAllPropertyInfo

getProperty

getMinCellPixels

setMinCellPixels

getCellSize

setLineWidth

getLineWidth

getLockAxesToWorld

setLockAxesToWorld

getPosition

setPosition

getOrientation

setOrientation

setResolution

setResolution

getResolution

isAutoSized

setAutoSized

numCellDivisions

getCellDivisions

setMinSize

getMinSize

getGridToWorld

alignPoint

setGridToWorld

getGridToWorld

setViewer

getViewer

getDragger

setDragger

isGridVisible

setGridVisible

render

getPlane

getPlane

getPlaneValues

getPlaneValues

centerInViewer

resetInViewer

getMajorColor

setMajorColor

getUseWorldOrigin

setUseWorldOrigin

getXAxisLabeling

setXAxisLabeling

getYAxisLabeling

setYAxisLabeling

setLabelSize

getLabelSize

setLabelColor

getLabelColor

getXAxisColor

setXAxisColor

getYAxisColor

setYAxisColor

getZAxisColor

setZAxisColor

getMinorColor

setMinorColor

main