Skip to content

Commit 0efa9a6

Browse files
committed
docu: update Scene
1 parent 51c1081 commit 0efa9a6

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

src/Composition/scene.jl

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -303,27 +303,27 @@ end
303303
304304
Defines global properties of the system, such as the gravity field. Exactly one [Object3D](@ref) must have a `Scene` feature defined. This Object3D is used as inertial system (world, root) and is not allowed to have a parent Object3D.
305305
306-
| Keyword arguments | defaults |
307-
|:------------------------------|:----------------------------------------|
308-
| `gravityField` | [`UniformGravityField`](@ref)`()` |
309-
| `enableVisualization` | true |
310-
| `visualizeFrames` | false |
311-
| `nominalLength` | 1.0 |
312-
| `defaultFrameLength` | 0.2*`nominalLength` |
306+
| Keyword arguments | defaults |
307+
|:--------------------------------|:----------------------------------------|
308+
| `gravityField` | [`UniformGravityField`](@ref)`()` |
313309
| `useOptimizedStructure` | true |
314310
| `enableContactDetection` | true |
315311
| `contactDetection` | [`ContactDetectionMPR_handler`](@ref)`()`|
316312
| `elasticContactReductionFactor` | 1.0 |
313+
| `enableVisualization` | true |
314+
| `animationFile` | nothing |
315+
| `visualizeFrames` | false |
317316
| `visualizeBoundingBox` | false |
318317
| `visualizeContactPoints` | false |
319318
| `visualizeSupportPoints` | false |
319+
| `nominalLength` | 1.0 |
320+
| `defaultFrameLength` | 0.2*`nominalLength` |
320321
| `nVisualContSupPoints` | 5 |
321322
| `defaultContactSphereDiameter` | 0.1 |
322-
| `animationFile` | nothing |
323-
| `cameraDistance` | 10.0*`nominalLength` |
323+
| `cameraDistance` | 10.0*`nominalLength` |
324324
| `cameraLongitude` | 30/180*pi |
325325
| `cameraLatitude` | 15/180*pi |
326-
| `lightDistance` | 10.0*`nominalLength` |
326+
| `lightDistance` | 10.0*`nominalLength` |
327327
| `lightLongitude` | 60/180*pi |
328328
| `lightLatitude` | 45/180*pi |
329329
@@ -334,14 +334,6 @@ Defines global properties of the system, such as the gravity field. Exactly one
334334
- [`UniformGravityField`](@ref),
335335
- [`PointGravityField`](@ref)
336336
337-
- `enableVisualization::Bool`: = true, to enable online animation with DLR SimVis. If SimVis is not installed, this flag has no effect.
338-
339-
- `visualizeFrames::Bool`: = true, to visualize the coordinate system of every [Object3D](@ref) that is not explicitly switched off.
340-
341-
- `nominalLength::Float64`: Nominal length in [m].
342-
343-
- `defaultFrameLength::Float64`: Default frame length in [m] for visualizing little [CoordinateSystem](@ref).
344-
345337
- `useOptimizedStructure::Bool`: = true, if pre-processing the whole system. For example, computing the common mass, common center of mass and common inertia tensor of all rigidly connected Object3Ds that have mass properties.
346338
347339
- `enableContactDetection::Bool`: = true, if contact detection is enable, see [Collision Handling](@ref).
@@ -351,18 +343,26 @@ Defines global properties of the system, such as the gravity field. Exactly one
351343
- `elasticContactReductionFactor::Float64`: (> 0.0)
352344
- ``usedContactCompliance = contactCompliance * elasticContactReductionFactor``
353345
346+
- `enableVisualization::Bool`: = true, to enable online animation with DLR SimVis. If SimVis is not installed, this flag has no effect.
347+
348+
- `animationFile::String`: only if a valid path and name of the animation file is set (it must be a .json file) a json file is exported
349+
350+
- `visualizeFrames::Bool`: = true, to visualize the coordinate system of every [Object3D](@ref) that is not explicitly switched off.
351+
354352
- `visualizeBoundingBox::Bool`: Flag enabled for visualizing Axis Aligned Bounding Box (AABB) for all solid shapes allowed to collide
355353
356354
- `visualizeContactPoints::Bool`: Flag enabled for visualizing contact points, and `enableVisualization = true`
357355
358356
- `visualizeSupportPoints::Bool`: Flag enabled for visualizing support points, and `enableVisualization = true`
359357
358+
- `nominalLength::Float64`: Nominal length in [m].
359+
360+
- `defaultFrameLength::Float64`: Default frame length in [m] for visualizing little [CoordinateSystem](@ref).
361+
360362
- `nVisualContSupPoints::Int64`: defines how many contact as well as support points are visualized (there is a warning if you'll need to increase it)
361363
362364
- `defaultContactSphereDiameter::Float64`: diameter of [Sphere](@ref) in [m] used for contact and support point visualization
363365
364-
- `animationFile::String`: only if a valid path and name of the animation file is set (it must be a .json file) a json file is exported
365-
366366
- `cameraDistance::Float64`: distance between world frame and camera position
367367
368368
- `cameraLongitude::Float64`: longitude angle of camera position (0 = -y/-z/-x direction)

0 commit comments

Comments
 (0)