MOMENTUM_NAMESPACE::Screw1D Class Reference

#include <Screw1D.h>

Public Member Functions
bool	getEnable () const
agx::Real	getLead () const
void	setEnable (bool enable)
void	setLead (double lead)

Detailed Description

The screw joint couples the vertical and rotational movement for the cylinder joint.

Member Function Documentation

getEnable()

bool MOMENTUM_NAMESPACE::Screw1D::getEnable

(

)

const

getLead()

agx::Real MOMENTUM_NAMESPACE::Screw1D::getLead

(

)

const

Returns

the lead of this screw controller

setEnable()

void MOMENTUM_NAMESPACE::Screw1D::setEnable

(

bool

enable

)

setLead()

void MOMENTUM_NAMESPACE::Screw1D::setLead

(

double

lead

)

Assign lead, i.e., the distance along the screw's axis that is covered by one complete rotation.

Parameters

lead	- is the distance along the screw's axis that is covered by one complete rotation of the screw (360 degrees)