Skip to content

Spiral

This component belongs to the category of Engines. This engine turns on spiral any topological model.

Input Data

  • rest_position: rest position of the mechanical object

Output Data

  • position: position of the mechanical object once it has been turned on spiral

Additional Parameter

  • curvature: real defining the curvature of the spiral

Examples

An example scene involving the Spiral engine is available in examples/Component/Engine/Generate/spiral.scn

Target: Sofa.Component.Engine.Generate

namespace: sofa::component::engine::generate

parents:

  • DataEngine

Data:

Name Description Default value
name object name unnamed
printLog if true, emits extra messages at runtime. 0
tags list of the subsets the objet belongs to
bbox this object bounding box
componentState The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). Undefined
listening if true, handle the events, otherwise ignore the events 0
curvature Spiral curvature factor 0.2
Inputs
rest_position Rest position coordinates of the degrees of freedom
Outputs
position Position coordinates of the degrees of freedom

Links:

Name Description
context Graph Node containing this object (or BaseContext::getDefault() if no graph is used)
slaves Sub-objects used internally by this object
master nullptr for regular objects, or master object for which this object is one sub-objects