Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## Class draw2d.SnapToHelper

    Object
       |
       +--draw2d.SnapToHelper

Direct Known Subclasses:
  draw2d.SnapToGeometry, draw2d.SnapToGrid

class draw2d.SnapToHelper

Defined in SnapToHelper.js
Version: 0.9.14
Author: Andreas Herz

Field Summary
`Object` | `workflow`
`<static> Object` | `EAST` East
`<static> Object` | `EAST_WEST` East-West: a bit-wise OR of EAST and WEST
`<static> Object` | `NORTH` North
`<static> Object` | `NORTH_EAST` North-East: a bit-wise OR of NORTH and EAST
`<static> Object` | `NORTH_SOUTH` North-South: a bit-wise OR of NORTH and SOUTH
`<static> Object` | `NORTH_WEST` North-West: a bit-wise OR of NORTH and WEST
`<static> Object` | `NSEW` North-South-East-West: a bit-wise OR of all 4 directions.
`<static> Object` | `SOUTH` South
`<static> Object` | `SOUTH_EAST` South-East: a bit-wise OR of SOUTH and EAST
`<static> Object` | `SOUTH_WEST` South-West: a bit-wise OR of SOUTH and WEST
`<static> Object` | `WEST` West

Constructor Summary
`draw2d.SnapToHelper ( workflow)`

Method Summary
`Object` | `snapPoint( snapOrientation, inputPoint, resultPoint)` Applies a snapping correction to the given result.
`Object` | `snapRectangle( inputBounds, resultBounds)` Applies a snap correction to a Rectangle based on a given Rectangle.

Field Detail

### workflow

    Object workflow

### EAST

    <static> Object EAST

East

### EAST_WEST

    <static> Object EAST_WEST

East-West: a bit-wise OR of EAST and WEST

### NORTH

    <static> Object NORTH

North

### NORTH_EAST

    <static> Object NORTH_EAST

North-East: a bit-wise OR of NORTH and EAST

### NORTH_SOUTH

    <static> Object NORTH_SOUTH

North-South: a bit-wise OR of NORTH and SOUTH

### NORTH_WEST

    <static> Object NORTH_WEST

North-West: a bit-wise OR of NORTH and WEST

### NSEW

    <static> Object NSEW

North-South-East-West: a bit-wise OR of all 4 directions.

### SOUTH

    <static> Object SOUTH

South

### SOUTH_EAST

    <static> Object SOUTH_EAST

South-East: a bit-wise OR of SOUTH and EAST

### SOUTH_WEST

    <static> Object SOUTH_WEST

South-West: a bit-wise OR of SOUTH and WEST

### WEST

    <static> Object WEST

West

Constructor Detail

### draw2d.SnapToHelper

    draw2d.SnapToHelper( workflow)

Version: 0.9.14
Author: Andreas Herz

Method Detail

### snapPoint

    Object snapPoint( snapOrientation, inputPoint, resultPoint)

Applies a snapping correction to the given result. Snapping can occur in the four primary directions: NORTH, SOUTH, EAST, WEST, as defined. By default a Point is treated as an empty Rectangle. Only NORTH and WEST should be used in general. But SOUTH and EAST may also be used.

### snapRectangle

    Object snapRectangle( inputBounds, resultBounds)

Applies a snap correction to a Rectangle based on a given Rectangle. The provided inputBounds will be used as a reference for snapping. The correction is applied to the result field (resultBounds).

Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Thu Feb 7 23:45:47 2008