Skip to content

ViewerSetting

Configuration for the Viewer of your application

Target: Sofa.Component.Setting

namespace: sofa::component::setting

parents:

  • ConfigurationSetting

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
resolution resolution of the Viewer 800 600
fullscreen Fullscreen mode 0
cameraMode Camera mode Perspective
objectPickingMethod The method used to pick objects Ray casting

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

Examples

Component/Setting/ViewerSetting.scn

<?xml version="1.0" ?>
<Node name="root" gravity="0 -1000 0" dt="0.04">
    <RequiredPlugin name="Sofa.Component.AnimationLoop"/> <!-- Needed to use components [FreeMotionAnimationLoop] -->
    <RequiredPlugin name="Sofa.Component.Collision.Detection.Algorithm"/> <!-- Needed to use components [BVHNarrowPhase BruteForceBroadPhase CollisionPipeline] -->
    <RequiredPlugin name="Sofa.Component.Collision.Detection.Intersection"/> <!-- Needed to use components [MinProximityIntersection] -->
    <RequiredPlugin name="Sofa.Component.Collision.Geometry"/> <!-- Needed to use components [LineCollisionModel PointCollisionModel TriangleCollisionModel] -->
    <RequiredPlugin name="Sofa.Component.Collision.Response.Contact"/> <!-- Needed to use components [CollisionResponse] -->
    <RequiredPlugin name="Sofa.Component.Constraint.Lagrangian.Correction"/> <!-- Needed to use components [UncoupledConstraintCorrection] -->
    <RequiredPlugin name="Sofa.Component.Constraint.Lagrangian.Solver"/> <!-- Needed to use components [LCPConstraintSolver] -->
    <RequiredPlugin name="Sofa.Component.IO.Mesh"/> <!-- Needed to use components [MeshOBJLoader] -->
    <RequiredPlugin name="Sofa.Component.LinearSolver.Iterative"/> <!-- Needed to use components [CGLinearSolver] -->
    <RequiredPlugin name="Sofa.Component.Mapping.Linear"/> <!-- Needed to use components [BarycentricMapping] -->
    <RequiredPlugin name="Sofa.Component.Mass"/> <!-- Needed to use components [UniformMass] -->
    <RequiredPlugin name="Sofa.Component.ODESolver.Backward"/> <!-- Needed to use components [EulerImplicitSolver] -->
    <RequiredPlugin name="Sofa.Component.Setting"/> <!-- Needed to use components [ViewerSetting] -->
    <RequiredPlugin name="Sofa.Component.SolidMechanics.FEM.Elastic"/> <!-- Needed to use components [HexahedronFEMForceField] -->
    <RequiredPlugin name="Sofa.Component.StateContainer"/> <!-- Needed to use components [MechanicalObject] -->
    <RequiredPlugin name="Sofa.Component.Topology.Container.Constant"/> <!-- Needed to use components [MeshTopology] -->
    <RequiredPlugin name="Sofa.Component.Topology.Container.Grid"/> <!-- Needed to use components [SparseGridRamificationTopology] -->
    <RequiredPlugin name="Sofa.Component.Visual"/> <!-- Needed to use components [VisualStyle] -->
    <RequiredPlugin name="Sofa.GL.Component.Rendering3D"/> <!-- Needed to use components [OglModel] -->
    <RequiredPlugin name="Sofa.GL.Component.Shader"/> <!-- Needed to use components [LightManager SpotLight] -->

    <!-- Change the viewer size here -->
    <ViewerSetting resolution="800 600"/>

    <VisualStyle displayFlags="showVisual  " /> <!--showBehaviorModels showCollisionModels-->
    <LCPConstraintSolver tolerance="1e-3" maxIt="1000" initial_guess="false" build_lcp="false"  printLog="0" mu="0.2"/>
    <FreeMotionAnimationLoop />
    <CollisionPipeline depth="15" verbose="0" draw="0" />
    <BruteForceBroadPhase/>
    <BVHNarrowPhase/>
    <MinProximityIntersection name="Proximity" alarmDistance="1.5" contactDistance="1" />

    <LightManager />
    <SpotLight name="light1" color="1 1 1" position="0 80 25" direction="0 -1 -0.8" cutoff="30" exponent="1" />
    <SpotLight name="light2" color="1 1 1" position="0 40 100" direction="0 0 -1" cutoff="30" exponent="1" />

    <CollisionResponse name="Response" response="FrictionContactConstraint" />
    <Node name="Snake" >

        <SparseGridRamificationTopology n="4 12 3" fileTopology="mesh/snake_body.obj" nbVirtualFinerLevels="3" finestConnectivity="0" />

        <EulerImplicitSolver name="cg_odesolver" rayleighMass="1" rayleighStiffness="0.03" />
        <CGLinearSolver name="linear solver" iterations="20" tolerance="1e-12" threshold="1e-18" />
        <MechanicalObject name="dofs"  scale="1" dy="2"/>
        <UniformMass totalMass="1.0" />
        <HexahedronFEMForceField name="FEM" youngModulus="30000.0" poissonRatio="0.3" method="large" updateStiffnessMatrix="false" printLog="0" />

        <UncoupledConstraintCorrection />

        <Node name="Collis">
            <MeshOBJLoader name="loader" filename="mesh/meca_snake_900tri.obj" />
            <MeshTopology src="@loader" />
            <MechanicalObject src="@loader" name="CollisModel" />
            <TriangleCollisionModel  selfCollision="0" />
            <LineCollisionModel    selfCollision="0" />
            <PointCollisionModel  selfCollision="0" />
            <BarycentricMapping input="@.." output="@." />
        </Node>

        <Node name="VisuBody" tags="Visual" >
                        <MeshOBJLoader name="meshLoader_0" filename="mesh/snake_body.obj" handleSeams="1" />
                        <OglModel  name="VisualBody" src="@meshLoader_0"   />
            <BarycentricMapping input="@.." output="@VisualBody" />
        </Node>

        <Node name="VisuCornea" tags="Visual" >
                        <MeshOBJLoader name="meshLoader_3" filename="mesh/snake_cornea.obj" handleSeams="1" />
                        <OglModel  name="VisualCornea" src="@meshLoader_3"   />
            <BarycentricMapping input="@.." output="@VisualCornea" />
        </Node>

        <Node name="VisuEye" tags="Visual" >
                        <MeshOBJLoader name="meshLoader_1" filename="mesh/snake_yellowEye.obj" handleSeams="1" />
                        <OglModel  name="VisualEye" src="@meshLoader_1"   />
            <BarycentricMapping input="@.." output="@VisualEye" />
        </Node>
    </Node>

    <Node name="Base" >

        <Node name="Stick">
            <MeshOBJLoader name="loader" filename="mesh/collision_batons.obj" />
            <MeshTopology src="@loader" />
            <MechanicalObject src="@loader" name="CollisModel" />
            <LineCollisionModel simulated="false" moving="false" />
            <PointCollisionModel simulated="false"  moving="false"/>
        </Node>
        <Node name="Blobs">
            <MeshOBJLoader name="loader" filename="mesh/collision_boules_V3.obj" />
            <MeshTopology src="@loader" />
            <MechanicalObject src="@loader" name="CollisModel" />
            <TriangleCollisionModel simulated="false" moving="false"/>
            <LineCollisionModel simulated="false" moving="false"/>
            <PointCollisionModel simulated="false" moving="false"/>
        </Node>

        <Node name="Foot">
            <MeshOBJLoader name="loader" filename="mesh/collision_pied.obj" />
            <MeshTopology src="@loader" />
            <MechanicalObject src="@loader" name="CollisModel" />
            <TriangleCollisionModel simulated="false" moving="false"/>
            <LineCollisionModel simulated="false" moving="false"/>
            <PointCollisionModel simulated="false" moving="false"/>
        </Node>

        <Node name="Visu" tags="Visual" >
            <MeshOBJLoader name="meshLoader_2" filename="mesh/SOFA_pod.obj" handleSeams="1" />
            <OglModel  name="OglModel" src="@meshLoader_2" />
        </Node>
    </Node>
</Node>
def createScene(rootNode):

    root = rootNode.addChild('root', gravity="0 -1000 0", dt="0.04")
    root.addObject('RequiredPlugin', name="Sofa.Component.AnimationLoop")
    root.addObject('RequiredPlugin', name="Sofa.Component.Collision.Detection.Algorithm")
    root.addObject('RequiredPlugin', name="Sofa.Component.Collision.Detection.Intersection")
    root.addObject('RequiredPlugin', name="Sofa.Component.Collision.Geometry")
    root.addObject('RequiredPlugin', name="Sofa.Component.Collision.Response.Contact")
    root.addObject('RequiredPlugin', name="Sofa.Component.Constraint.Lagrangian.Correction")
    root.addObject('RequiredPlugin', name="Sofa.Component.Constraint.Lagrangian.Solver")
    root.addObject('RequiredPlugin', name="Sofa.Component.IO.Mesh")
    root.addObject('RequiredPlugin', name="Sofa.Component.LinearSolver.Iterative")
    root.addObject('RequiredPlugin', name="Sofa.Component.Mapping.Linear")
    root.addObject('RequiredPlugin', name="Sofa.Component.Mass")
    root.addObject('RequiredPlugin', name="Sofa.Component.ODESolver.Backward")
    root.addObject('RequiredPlugin', name="Sofa.Component.Setting")
    root.addObject('RequiredPlugin', name="Sofa.Component.SolidMechanics.FEM.Elastic")
    root.addObject('RequiredPlugin', name="Sofa.Component.StateContainer")
    root.addObject('RequiredPlugin', name="Sofa.Component.Topology.Container.Constant")
    root.addObject('RequiredPlugin', name="Sofa.Component.Topology.Container.Grid")
    root.addObject('RequiredPlugin', name="Sofa.Component.Visual")
    root.addObject('RequiredPlugin', name="Sofa.GL.Component.Rendering3D")
    root.addObject('RequiredPlugin', name="Sofa.GL.Component.Shader")
    root.addObject('ViewerSetting', resolution="800 600")
    root.addObject('VisualStyle', displayFlags="showVisual  ")
    root.addObject('LCPConstraintSolver', tolerance="1e-3", maxIt="1000", initial_guess="false", build_lcp="false", printLog="0", mu="0.2")
    root.addObject('FreeMotionAnimationLoop')
    root.addObject('CollisionPipeline', depth="15", verbose="0", draw="0")
    root.addObject('BruteForceBroadPhase')
    root.addObject('BVHNarrowPhase')
    root.addObject('MinProximityIntersection', name="Proximity", alarmDistance="1.5", contactDistance="1")
    root.addObject('LightManager')
    root.addObject('SpotLight', name="light1", color="1 1 1", position="0 80 25", direction="0 -1 -0.8", cutoff="30", exponent="1")
    root.addObject('SpotLight', name="light2", color="1 1 1", position="0 40 100", direction="0 0 -1", cutoff="30", exponent="1")
    root.addObject('CollisionResponse', name="Response", response="FrictionContactConstraint")

    Snake = root.addChild('Snake')
    Snake.addObject('SparseGridRamificationTopology', n="4 12 3", fileTopology="mesh/snake_body.obj", nbVirtualFinerLevels="3", finestConnectivity="0")
    Snake.addObject('EulerImplicitSolver', name="cg_odesolver", rayleighMass="1", rayleighStiffness="0.03")
    Snake.addObject('CGLinearSolver', name="linear solver", iterations="20", tolerance="1e-12", threshold="1e-18")
    Snake.addObject('MechanicalObject', name="dofs", scale="1", dy="2")
    Snake.addObject('UniformMass', totalMass="1.0")
    Snake.addObject('HexahedronFEMForceField', name="FEM", youngModulus="30000.0", poissonRatio="0.3", method="large", updateStiffnessMatrix="false", printLog="0")
    Snake.addObject('UncoupledConstraintCorrection')

    Collis = Snake.addChild('Collis')
    Collis.addObject('MeshOBJLoader', name="loader", filename="mesh/meca_snake_900tri.obj")
    Collis.addObject('MeshTopology', src="@loader")
    Collis.addObject('MechanicalObject', src="@loader", name="CollisModel")
    Collis.addObject('TriangleCollisionModel', selfCollision="0")
    Collis.addObject('LineCollisionModel', selfCollision="0")
    Collis.addObject('PointCollisionModel', selfCollision="0")
    Collis.addObject('BarycentricMapping', input="@..", output="@.")

    VisuBody = Snake.addChild('VisuBody', tags="Visual")
    VisuBody.addObject('MeshOBJLoader', name="meshLoader_0", filename="mesh/snake_body.obj", handleSeams="1")
    VisuBody.addObject('OglModel', name="VisualBody", src="@meshLoader_0")
    VisuBody.addObject('BarycentricMapping', input="@..", output="@VisualBody")

    VisuCornea = Snake.addChild('VisuCornea', tags="Visual")
    VisuCornea.addObject('MeshOBJLoader', name="meshLoader_3", filename="mesh/snake_cornea.obj", handleSeams="1")
    VisuCornea.addObject('OglModel', name="VisualCornea", src="@meshLoader_3")
    VisuCornea.addObject('BarycentricMapping', input="@..", output="@VisualCornea")

    VisuEye = Snake.addChild('VisuEye', tags="Visual")
    VisuEye.addObject('MeshOBJLoader', name="meshLoader_1", filename="mesh/snake_yellowEye.obj", handleSeams="1")
    VisuEye.addObject('OglModel', name="VisualEye", src="@meshLoader_1")
    VisuEye.addObject('BarycentricMapping', input="@..", output="@VisualEye")

    Base = root.addChild('Base')

    Stick = Base.addChild('Stick')
    Stick.addObject('MeshOBJLoader', name="loader", filename="mesh/collision_batons.obj")
    Stick.addObject('MeshTopology', src="@loader")
    Stick.addObject('MechanicalObject', src="@loader", name="CollisModel")
    Stick.addObject('LineCollisionModel', simulated="false", moving="false")
    Stick.addObject('PointCollisionModel', simulated="false", moving="false")

    Blobs = Base.addChild('Blobs')
    Blobs.addObject('MeshOBJLoader', name="loader", filename="mesh/collision_boules_V3.obj")
    Blobs.addObject('MeshTopology', src="@loader")
    Blobs.addObject('MechanicalObject', src="@loader", name="CollisModel")
    Blobs.addObject('TriangleCollisionModel', simulated="false", moving="false")
    Blobs.addObject('LineCollisionModel', simulated="false", moving="false")
    Blobs.addObject('PointCollisionModel', simulated="false", moving="false")

    Foot = Base.addChild('Foot')
    Foot.addObject('MeshOBJLoader', name="loader", filename="mesh/collision_pied.obj")
    Foot.addObject('MeshTopology', src="@loader")
    Foot.addObject('MechanicalObject', src="@loader", name="CollisModel")
    Foot.addObject('TriangleCollisionModel', simulated="false", moving="false")
    Foot.addObject('LineCollisionModel', simulated="false", moving="false")
    Foot.addObject('PointCollisionModel', simulated="false", moving="false")

    Visu = Base.addChild('Visu', tags="Visual")
    Visu.addObject('MeshOBJLoader', name="meshLoader_2", filename="mesh/SOFA_pod.obj", handleSeams="1")
    Visu.addObject('OglModel', name="OglModel", src="@meshLoader_2")