Public Types | Public Member Functions | Friends | List of all members
pinocchio::CollisionPair Struct Reference

#include <geometry.hpp>

Inheritance diagram for pinocchio::CollisionPair:
Inheritance graph
[legend]

Public Types

typedef std::pair< GeomIndex, GeomIndexBase
 

Public Member Functions

 CollisionPair ()
 Empty constructor. More...
 
 CollisionPair (const GeomIndex co1, const GeomIndex co2)
 Default constructor of a collision pair from two collision object indexes. More...
 
void disp (std::ostream &os) const
 
bool operator!= (const CollisionPair &rhs) const
 
bool operator== (const CollisionPair &rhs) const
 

Friends

std::ostream & operator<< (std::ostream &os, const CollisionPair &X)
 

Detailed Description

Definition at line 21 of file multibody/geometry.hpp.

Member Typedef Documentation

◆ Base

Definition at line 24 of file multibody/geometry.hpp.

Constructor & Destructor Documentation

◆ CollisionPair() [1/2]

pinocchio::CollisionPair::CollisionPair ( )

Empty constructor.

◆ CollisionPair() [2/2]

pinocchio::CollisionPair::CollisionPair ( const GeomIndex  co1,
const GeomIndex  co2 
)

Default constructor of a collision pair from two collision object indexes.

Remarks
The two indexes must be different, otherwise the constructor throws.
Parameters
[in]co1Index of the first collision object.
[in]co2Index of the second collision object.

Member Function Documentation

◆ disp()

void pinocchio::CollisionPair::disp ( std::ostream &  os) const

◆ operator!=()

bool pinocchio::CollisionPair::operator!= ( const CollisionPair rhs) const

◆ operator==()

bool pinocchio::CollisionPair::operator== ( const CollisionPair rhs) const

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const CollisionPair X 
)
friend

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


pinocchio
Author(s):
autogenerated on Sun Dec 22 2024 03:41:14