Public Member Functions | Public Attributes | List of all members
hpp::fcl::QueryRequest Struct Reference

base class for all query requests More...

#include <collision_data.h>

Inheritance diagram for hpp::fcl::QueryRequest:
Inheritance graph
[legend]

Public Member Functions

QueryRequestoperator= (const QueryRequest &other)=default
 Copy assignment operator. More...
 
bool operator== (const QueryRequest &other) const
 whether two QueryRequest are the same or not More...
 
HPP_FCL_COMPILER_DIAGNOSTIC_PUSH HPP_FCL_COMPILER_DIAGNOSTIC_IGNORED_DEPRECECATED_DECLARATIONS QueryRequest ()
 Default constructor. More...
 
 QueryRequest (const QueryRequest &other)=default
 Copy constructor. More...
 
HPP_FCL_COMPILER_DIAGNOSTIC_POP void updateGuess (const QueryResult &result)
 

Public Attributes

Vec3f cached_gjk_guess
 the gjk initial guess set by user More...
 
support_func_guess_t cached_support_func_guess
 the support function initial guess set by user More...
 
FCL_REAL collision_distance_threshold
 threshold below which a collision is considered. More...
 
bool enable_cached_gjk_guess
 whether enable gjk initial guess @Deprecated Use gjk_initial_guess instead More...
 
bool enable_timings
 enable timings when performing collision/distance request More...
 
GJKConvergenceCriterion gjk_convergence_criterion
 convergence criterion used to stop GJK More...
 
GJKConvergenceCriterionType gjk_convergence_criterion_type
 convergence criterion used to stop GJK More...
 
GJKInitialGuess gjk_initial_guess
 
size_t gjk_max_iterations
 maximum iteration for the GJK algorithm More...
 
FCL_REAL gjk_tolerance
 tolerance for the GJK algorithm More...
 
GJKVariant gjk_variant
 whether to enable the Nesterov accleration of GJK More...
 

Detailed Description

base class for all query requests

Definition at line 119 of file collision_data.h.

Constructor & Destructor Documentation

◆ QueryRequest() [1/2]

Default constructor.

Definition at line 158 of file collision_data.h.

◆ QueryRequest() [2/2]

hpp::fcl::QueryRequest::QueryRequest ( const QueryRequest other)
default

Copy constructor.

Member Function Documentation

◆ operator=()

QueryRequest& hpp::fcl::QueryRequest::operator= ( const QueryRequest other)
default

Copy assignment operator.

◆ operator==()

bool hpp::fcl::QueryRequest::operator== ( const QueryRequest other) const
inline

whether two QueryRequest are the same or not

Definition at line 182 of file collision_data.h.

◆ updateGuess()

void hpp::fcl::QueryRequest::updateGuess ( const QueryResult result)
inline

Definition at line 210 of file collision_data.h.

Member Data Documentation

◆ cached_gjk_guess

Vec3f hpp::fcl::QueryRequest::cached_gjk_guess

the gjk initial guess set by user

Definition at line 144 of file collision_data.h.

◆ cached_support_func_guess

support_func_guess_t hpp::fcl::QueryRequest::cached_support_func_guess

the support function initial guess set by user

Definition at line 147 of file collision_data.h.

◆ collision_distance_threshold

FCL_REAL hpp::fcl::QueryRequest::collision_distance_threshold

threshold below which a collision is considered.

Definition at line 153 of file collision_data.h.

◆ enable_cached_gjk_guess

bool hpp::fcl::QueryRequest::enable_cached_gjk_guess

whether enable gjk initial guess @Deprecated Use gjk_initial_guess instead

Definition at line 126 of file collision_data.h.

◆ enable_timings

bool hpp::fcl::QueryRequest::enable_timings

enable timings when performing collision/distance request

Definition at line 150 of file collision_data.h.

◆ gjk_convergence_criterion

GJKConvergenceCriterion hpp::fcl::QueryRequest::gjk_convergence_criterion

convergence criterion used to stop GJK

Definition at line 132 of file collision_data.h.

◆ gjk_convergence_criterion_type

GJKConvergenceCriterionType hpp::fcl::QueryRequest::gjk_convergence_criterion_type

convergence criterion used to stop GJK

Definition at line 135 of file collision_data.h.

◆ gjk_initial_guess

GJKInitialGuess hpp::fcl::QueryRequest::gjk_initial_guess

Definition at line 121 of file collision_data.h.

◆ gjk_max_iterations

size_t hpp::fcl::QueryRequest::gjk_max_iterations

maximum iteration for the GJK algorithm

Definition at line 141 of file collision_data.h.

◆ gjk_tolerance

FCL_REAL hpp::fcl::QueryRequest::gjk_tolerance

tolerance for the GJK algorithm

Definition at line 138 of file collision_data.h.

◆ gjk_variant

GJKVariant hpp::fcl::QueryRequest::gjk_variant

whether to enable the Nesterov accleration of GJK

Definition at line 129 of file collision_data.h.


The documentation for this struct was generated from the following file:


hpp-fcl
Author(s):
autogenerated on Fri Aug 2 2024 02:45:16