Skip to content

Commit

Permalink
document <plane>
Browse files Browse the repository at this point in the history
  • Loading branch information
rdeits committed Apr 24, 2018
1 parent 109a8fb commit 1858e0e
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ visual_elements(mechanism::Mechanism, source::AbstractGeometrySource)
* `color`: an RGBA color from [ColorTypes.jl](https://github.com/JuliaGraphics/ColorTypes.jl)
* `transform`: a `Transformation` from [CoordinateTransformations.jl](https://github.com/FugroRoames/CoordinateTransformations.jl/) indicating the pose of the geometry w.r.t its attached frame.

## Currently implemented sources
# Currently implemented sources

These demonstrations use the Boston Dynamics Atlas robot from [AtlasRobot.jl](https://github.com/tkoolen/AtlasRobot.jl).

Expand All @@ -31,7 +31,7 @@ mechanism = AtlasRobot.mechanism()
```


### Skeleton
## Skeleton

```julia
Skeleton <: AbstractGeometrySource
Expand All @@ -53,7 +53,7 @@ visual_elements(mechanism, Skeleton(inertias=false))

![skeleton_no_inertias](https://user-images.githubusercontent.com/591886/37125810-1ac0f4c4-223c-11e8-845a-cf17893eba93.png)

### URDF Visuals
## URDF Visuals

```julia
URDFVisuals <: AbstractGeometrySource
Expand All @@ -69,7 +69,11 @@ visual_elements(mechanism,

![urdf_visuals](https://user-images.githubusercontent.com/591886/37125819-1de2441e-223c-11e8-9db2-87f814cfea63.png)

### URDF Extensions

The following extensions to the URDF spec are parsed by MechanismGeometries.jl:

* `<plane normal="0 0 1"/>`: Represents an infinite plane perpendicular to the `normal` given as an x y z unit vector. Returns a MechanismGeometries.HyperPlane



Expand Down

0 comments on commit 1858e0e

Please sign in to comment.