Skip to content

Latest commit

 

History

History
241 lines (211 loc) · 13.5 KB

File metadata and controls

241 lines (211 loc) · 13.5 KB

\defgroup -Sofa Sofa \defgroup -Sofa-sofa sofa \ingroup -Sofa \defgroup -Sofa-sofa-collisionAlgorithm collisionAlgorithm \ingroup -Sofa-sofa \defgroup -Sofa-sofa-collisionAlgorithm-AABBBroadPhase AABBBroadPhase \ingroup -Sofa-sofa-collisionAlgorithm ##Description

AABBBroadPhase is a real-time collision detection component that uses the Axis-Aligned Bounding Box (AABB) approach for broad-phase collision handling.

It organizes elements into a 3D spatial grid, efficiently indexing and retrieving them to identify potential collisions, optimizing the process of narrowing down collision checks for more precise detection in 3D simulations.

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • nbox (sofa::type::Vec<3u, int>):
    number of bbox
  • isStatic (bool):
    Optimization: object is not moving in the scene
  • method (int):
    chosen method to determine the boxes containing the elements
  • thread (int):
    Number of threads ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-CollisionLoop CollisionLoop \ingroup -Sofa-sofa-collisionAlgorithm ##Description CollisionLoop

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-DistanceFilter DistanceFilter \ingroup -Sofa-sofa-collisionAlgorithm ##Description DistanceFilter

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • distance (double):
    Min distance ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-EdgeGeometry EdgeGeometry \ingroup -Sofa-sofa-collisionAlgorithm ##Description EdgeGeometry

\defgroup -Sofa-sofa-collisionAlgorithm-EdgeGeometry-Vec3d EdgeGeometry \ingroup -Sofa-sofa-collisionAlgorithm-EdgeGeometry ##Description EdgeGeometry

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • color (sofa::type::RGBAColor):
    Color of the collision model
  • drawScaleNormal (double):
    Color of the collision model
  • draw (bool):
    draw ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-Find2DClosestProximityAlgorithm Find2DClosestProximityAlgorithm \ingroup -Sofa-sofa-collisionAlgorithm ##Description Find2DClosestProximityAlgorithm

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • drawcollision (bool):
    draw collision
  • projectionMatrix (sofa::type::Mat<3u, 4u, double>):
    projection matrix
  • output (sofa::collisionAlgorithm::DetectionOutput<sofa::collisionAlgorithm::BaseProximity, sofa::collisionAlgorithm::BaseProximity>):
    output of the collision detection ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-FindClosestProximityAlgorithm FindClosestProximityAlgorithm \ingroup -Sofa-sofa-collisionAlgorithm ##Description FindClosestProximityAlgorithm

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • drawcollision (bool):
    draw collision
  • output (sofa::collisionAlgorithm::DetectionOutput<sofa::collisionAlgorithm::BaseProximity, sofa::collisionAlgorithm::BaseProximity>):
    output of the collision detection
  • projective (bool):
    projection of closest prox onto from element ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-FullAABBBroadPhase FullAABBBroadPhase \ingroup -Sofa-sofa-collisionAlgorithm ##Description FullAABBBroadPhase

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • nbox (sofa::type::Vec<3u, int>):
    number of bbox
  • isStatic (bool):
    Optimization: object is not moving in the scene
  • method (int):
    chosen method to determine the boxes containing the elements
  • thread (int):
    Number of threads ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-PointGeometry PointGeometry \ingroup -Sofa-sofa-collisionAlgorithm ##Description PointGeometry

\defgroup -Sofa-sofa-collisionAlgorithm-PointGeometry-Vec3d PointGeometry \ingroup -Sofa-sofa-collisionAlgorithm-PointGeometry ##Description PointGeometry

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • color (sofa::type::RGBAColor):
    Color of the collision model
  • drawScaleNormal (double):
    Color of the collision model
  • draw (bool):
    draw ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-SubsetGeometry SubsetGeometry \ingroup -Sofa-sofa-collisionAlgorithm ##Description SubsetGeometry

\defgroup -Sofa-sofa-collisionAlgorithm-SubsetGeometry-Vec3d SubsetGeometry \ingroup -Sofa-sofa-collisionAlgorithm-SubsetGeometry ##Description SubsetGeometry

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • color (sofa::type::RGBAColor):
    Color of the collision model
  • drawScaleNormal (double):
    Color of the collision model
  • draw (bool):
    draw
  • indices (sofa::type::vector<int, sofa::type::CPUMemoryManager >):
    Indices to keep ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-TetrahedronGeometry TetrahedronGeometry \ingroup -Sofa-sofa-collisionAlgorithm ##Description TetrahedronGeometry

\defgroup -Sofa-sofa-collisionAlgorithm-TetrahedronGeometry-Vec3d TetrahedronGeometry \ingroup -Sofa-sofa-collisionAlgorithm-TetrahedronGeometry ##Description TetrahedronGeometry

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • color (sofa::type::RGBAColor):
    Color of the collision model
  • drawScaleNormal (double):
    Color of the collision model
  • draw (bool):
    draw ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection

\defgroup -Sofa-sofa-collisionAlgorithm-TriangleGeometry TriangleGeometry \ingroup -Sofa-sofa-collisionAlgorithm ##Description TriangleGeometry

\defgroup -Sofa-sofa-collisionAlgorithm-TriangleGeometry-Vec3d TriangleGeometry \ingroup -Sofa-sofa-collisionAlgorithm-TriangleGeometry ##Description TriangleGeometry

##Parameters:

  • name (std::__cxx11::basic_string<char, std::char_traits, std::allocator >):
    object name
  • printLog (bool):
    if true, emits extra messages at runtime.
  • tags (sofa::core::objectmodel::TagSet):
    list of the subsets the object belongs to
  • bbox (sofa::type::BoundingBox):
    this object bounding box
  • componentState (sofa::core::objectmodel::ComponentState):
    The state of the component among (Dirty, Valid, Undefined, Loading, Invalid).
  • listening (bool):
    if true, handle the events, otherwise ignore the events
  • color (sofa::type::RGBAColor):
    Color of the collision model
  • drawScaleNormal (double):
    Color of the collision model
  • draw (bool):
    draw ##Output Signals:
  • connection : Signal event called at connection
  • disconnection : Signal event called at connection