Public Member Functions | Public Attributes | List of all members
tesseract_collision::ContactRequest Struct Reference

The ContactRequest struct. More...

#include <types.h>

Public Member Functions

 ContactRequest (ContactTestType type=ContactTestType::ALL)
 
bool operator!= (const ContactRequest &rhs) const
 
bool operator== (const ContactRequest &rhs) const
 

Public Attributes

bool calculate_distance = true
 This enables the calculation of distance data if two objects are within the contact threshold. More...
 
bool calculate_penetration = true
 This enables the calculation of penetration contact data if two objects are in collision. More...
 
long contact_limit = 0
 This is used if the ContactTestType is set to LIMITED, where the test will exit when number of contacts reach this limit. More...
 
std::shared_ptr< const ContactResultValidatoris_valid
 This provides a user defined function approve/reject contact results. More...
 
ContactTestType type = ContactTestType::ALL
 This controls the exit condition for the contact test type. More...
 

Detailed Description

The ContactRequest struct.

Definition at line 300 of file types.h.

Constructor & Destructor Documentation

◆ ContactRequest()

tesseract_collision::ContactRequest::ContactRequest ( ContactTestType  type = ContactTestType::ALL)

Definition at line 89 of file types.cpp.

Member Function Documentation

◆ operator!=()

bool tesseract_collision::ContactRequest::operator!= ( const ContactRequest rhs) const

Definition at line 101 of file types.cpp.

◆ operator==()

bool tesseract_collision::ContactRequest::operator== ( const ContactRequest rhs) const

Definition at line 91 of file types.cpp.

Member Data Documentation

◆ calculate_distance

bool tesseract_collision::ContactRequest::calculate_distance = true

This enables the calculation of distance data if two objects are within the contact threshold.

Definition at line 309 of file types.h.

◆ calculate_penetration

bool tesseract_collision::ContactRequest::calculate_penetration = true

This enables the calculation of penetration contact data if two objects are in collision.

Definition at line 306 of file types.h.

◆ contact_limit

long tesseract_collision::ContactRequest::contact_limit = 0

This is used if the ContactTestType is set to LIMITED, where the test will exit when number of contacts reach this limit.

Definition at line 313 of file types.h.

◆ is_valid

std::shared_ptr<const ContactResultValidator> tesseract_collision::ContactRequest::is_valid

This provides a user defined function approve/reject contact results.

Definition at line 316 of file types.h.

◆ type

ContactTestType tesseract_collision::ContactRequest::type = ContactTestType::ALL

This controls the exit condition for the contact test type.

Definition at line 303 of file types.h.


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


tesseract_collision
Author(s): Levi Armstrong
autogenerated on Sun May 18 2025 03:01:53