AliceVision
Photogrammetric Computer Vision Framework
Public Member Functions | List of all members
aliceVision::sfmData::Rig Class Reference

Public Member Functions

 Rig (unsigned int nbSubPoses=0)
 Rig constructor. More...
 
bool operator== (const Rig &other) const
 operator == More...
 
bool isInitialized () const
 Check if the rig has at least one sub-pose initialized. More...
 
bool isFullyCalibrated () const
 
std::size_t getNbSubPoses () const
 Get the number of sub-poses in the rig. More...
 
const std::vector< RigSubPose > & getSubPoses () const
 Get the sub-poses const vector. More...
 
std::vector< RigSubPose > & getSubPoses ()
 Get the sub-poses const vector. More...
 
const RigSubPosegetSubPose (IndexT index) const
 Get the sub-pose for the given sub-pose index. More...
 
RigSubPosegetSubPose (IndexT index)
 Get the sub-pose for the given sub-pose index. More...
 
void setSubPose (IndexT index, const RigSubPose &rigSubPose)
 Set the given sub-pose for the given sub-pose index. More...
 
void reset ()
 Reset all sub-poses parameters.
 

Constructor & Destructor Documentation

◆ Rig()

aliceVision::sfmData::Rig::Rig ( unsigned int  nbSubPoses = 0)
inlineexplicit

Rig constructor.

Parameters
nbSubPosesThe number of sub-poses of the rig

Member Function Documentation

◆ getNbSubPoses()

std::size_t aliceVision::sfmData::Rig::getNbSubPoses ( ) const
inline

Get the number of sub-poses in the rig.

Returns
number of sub-poses in the rig

◆ getSubPose() [1/2]

RigSubPose& aliceVision::sfmData::Rig::getSubPose ( IndexT  index)
inline

Get the sub-pose for the given sub-pose index.

Parameters
indexThe sub-pose index
Returns
corresponding rig sub-pose

◆ getSubPose() [2/2]

const RigSubPose& aliceVision::sfmData::Rig::getSubPose ( IndexT  index) const
inline

Get the sub-pose for the given sub-pose index.

Parameters
indexThe sub-pose index
Returns
corresponding rig sub-pose

◆ getSubPoses() [1/2]

std::vector<RigSubPose>& aliceVision::sfmData::Rig::getSubPoses ( )
inline

Get the sub-poses const vector.

Returns
rig sub-poses

◆ getSubPoses() [2/2]

const std::vector<RigSubPose>& aliceVision::sfmData::Rig::getSubPoses ( ) const
inline

Get the sub-poses const vector.

Returns
rig sub-poses

◆ isInitialized()

bool aliceVision::sfmData::Rig::isInitialized ( ) const
inline

Check if the rig has at least one sub-pose initialized.

Returns
true if at least one subpose initialized

◆ operator==()

bool aliceVision::sfmData::Rig::operator== ( const Rig other) const
inline

operator ==

Parameters
otherthe other Rig
Returns
true if the current rig and the other are identical.

◆ setSubPose()

void aliceVision::sfmData::Rig::setSubPose ( IndexT  index,
const RigSubPose rigSubPose 
)
inline

Set the given sub-pose for the given sub-pose index.

Parameters
indexThe sub-pose index
rigSubPoseThe rig sub-pose

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