AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agx::ConeLimit Class Reference

Elementary secondary constraint to set a conic limit to a BallJoint. More...

#include <ElementaryConstraint.h>

+ Inheritance diagram for agx::ConeLimit:

Public Member Functions

 ConeLimit (const ConeLimitData &data)
 Constructor for ConeLimit.
 
 AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agx::ConeLimit)
 
Real getCurrentAngle () const
 Get the current angle between the centre of the cone limit and the axis limited by the constraint.
 
Vec2 getLimitAngles () const
 Get the cone limit angles, which defines how much a rod in a ball joint can rotate.
 
virtual Bool isActive () const override
 
void setLimitAngles (Real a1, Real a2)
 Set the cone limit angles, which defines the max angle in two different directions.
 
void setLimitAngles (Real coneAngle)
 Set the cone limit angles to the same angle, creating a circular limit.
 
void setLimitAngles (Vec2 limit)
 Set the cone limit angles, which defines the max angle in two different directions.
 
- Public Member Functions inherited from agx::ElementaryConstraintNData< 1, ConeLimitData >
 ElementaryConstraintNData (const ConeLimitData &data, agx::Bool enable)
 Construct given data and enable flag.
 
 ElementaryConstraintNData (const ElementaryConstraintNData &)=delete
 
ConeLimitData & getData ()
 
const ConeLimitData & getData () const
 
ElementaryConstraintNData & operator= (const ElementaryConstraintNData &)=delete
 
virtual void setAttachmentPair (const agx::AttachmentPair *ap) override
 Data has to support assignment of attachment pair.
 
- Public Member Functions inherited from agx::ElementaryConstraintN< N >
 ElementaryConstraintN (agx::Bool enable)
 Construct given enable flag.
 
- Public Member Functions inherited from agx::ElementaryConstraint
 AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agx::ElementaryConstraint)
 
void copyRowFrom (const ElementaryConstraint *source, agx::UInt sourceRow, agx::UInt destRow)
 Copy configuration row from the given ElementaryConstraint into this.
 
virtual agx::UInt getBounds (agx::RangeReal *bounds, agx::UInt row, agx::Real h) const
 Returns the bounds of the Lagrange Multipliers (default (-inf, +inf)).
 
agx::Real getCompliance (agx::UInt row=0) const
 
virtual agx::Real getCurrentForce (const agx::UInt row=0) const
 Returns the force applied last time step by this elementary constraint.
 
const agx::Real * getCurrentForces () const
 
agx::Real getDamping (agx::UInt row=0) const
 
agx::Real getElasticity (agx::UInt row=0) const
 
virtual agx::Bool getEnable () const
 
agx::RangeReal & getForceRange (const agx::UInt row=0)
 
const agx::RangeReal & getForceRange (const agx::UInt row=0) const
 
virtual agx::UInt getJacobian (agx::Jacobian6DOFElement *G, agx::UInt numBlocks, agx::UInt row, agx::GWriteState::Enum writeState)
 Returns the Jacobian of this elementary constraint.
 
const agx::ElementaryConstraint::NameType & getName () const
 
virtual agx::ConstraintNlmcpCallback * getNlCallback () const
 
agx::UInt getNumRows () const
 
agx::RegularizationParameters * getRegularizationParameters (const agx::UInt row=0)
 
const agx::RegularizationParameters * getRegularizationParameters (const agx::UInt row=0) const
 
virtual agx::UInt getVelocity (agx::Real *v, agx::UInt row) const
 Returns the velocity of this elementary constraint (extra, driving term on the right hand side).
 
virtual agx::UInt getViolation (agx::Real *g, agx::UInt row)
 Returns the violation of this elementary constraint.
 
virtual agx::Bool isActive () const
 An elementary constraint is defined to be active if enabled.
 
virtual agx::Bool isImpacting () const
 
virtual void linearizeCompliance (const agx::Real *violations, agx::Real *epsilons, agx::Real minPerturbation) const
 Modify epsilon so that this ElementaryConstraint appear to be linear in the "normal" deformantion space instead any other space that the ElementaryConstraint may be using.
 
virtual agx::UInt postSolveCallback (const agx::Real *solution, agx::UInt row, agx::Real h)
 Callback after solve, with the solution.
 
virtual void prepare ()
 Prepare call.
 
void reset ()
 Reset call.
 
virtual void restore (agxStream::InputArchive &in) override
 Restore this object from stream.
 
virtual void restoreLightData (agxStream::StorageStream &str) override
 Restore structural independent data from stream.
 
virtual void setAttachmentPair (const agx::AttachmentPair *ap)
 Call for elementary constraints dependent on attachment pairs.
 
void setCompliance (agx::Real compliance)
 
void setCompliance (agx::Real compliance, int row)
 Assign compliance for a given row, or all rows if row = -1 (default).
 
void setDamping (agx::Real damping)
 
void setDamping (agx::Real damping, int row)
 Assign damping for a given row, or all rows if row = -1 (default).
 
void setElasticity (agx::Real elasticity)
 
void setElasticity (agx::Real elasticity, int row)
 Assign elasticity for a given row, or all rows if row = -1 (default).
 
virtual void setEnable (agx::Bool enable)
 Enable/disable this elementary constraint.
 
void setForceRange (agx::RangeReal forceRange, const agx::UInt row=0)
 Assign force range to a given row.
 
void setForceRange (agx::Real lower, agx::Real upper, const agx::UInt row=0)
 Assign force range to a given row.
 
void setName (const agx::ElementaryConstraint::NameType &name)
 Name this elementary constraint.
 
virtual void store (agxStream::OutputArchive &out) const override
 Store this object to stream.
 
virtual void storeLightData (agxStream::StorageStream &str) const override
 Store structural independent data to stream.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
- Public Member Functions inherited from agxStream::Serializable
virtual ~Serializable ()
 Destructor for normal C++ use but hidden from SWIG bindings.
 
virtual const char * getClassName () const
 
bool getEnableSerialization () const
 
bool getEnableUuidGeneration ()
 
agx::UInt32 getIndex () const
 This index is given at creation of this object.
 
virtual StorageAgent * getStorageAgent () const =0
 
agx::Uuid getUuid () const
 
bool isFinished () const
 
void setEnableSerialization (bool flag)
 Set to false to disable serialization of this object.
 
void setFinished ()
 Tells this class that it is restored correctly and should not be deleted during destruction of an Archive.
 
void setUuid (const agx::Uuid &uuid)
 Explicitly set a Uuid on a serializable object.
 

Static Public Member Functions

static agxStream::Serializable * create (agxStream::InputArchive &)
 
static agx::ConeLimit * safeCast (const agx::ElementaryConstraint *coneLimit)
 Utility cast method.
 
- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Static Public Member Functions inherited from agxStream::Serializable
static void setEnableUuidGeneration (bool flag)
 Specify if there should be UUID:s generated for each new Serializable object. By default it is enabled.
 

Protected Member Functions

 ConeLimit ()
 Used during serialization restore.
 
virtual ~ConeLimit ()
 Reference counted object, protected destructor.
 
virtual agx::UInt getBounds (agx::RangeReal *bounds, agx::UInt row, agx::Real h) const override
 Returns the bounds of the Lagrange Multipliers (default (-inf, +inf)).
 
virtual UInt getJacobian (Jacobian6DOFElement *G, UInt numBlocks, UInt row, GWriteState::Enum writeState) override
 
virtual agx::UInt getViolation (agx::Real *g, agx::UInt row) override
 Returns the violation of this elementary constraint.
 
virtual void prepare () override
 Prepare call.
 
- Protected Member Functions inherited from agx::ElementaryConstraintNData< 1, ConeLimitData >
 ElementaryConstraintNData ()
 
- Protected Member Functions inherited from agx::ElementaryConstraintN< N >
 ElementaryConstraintN ()
 Used during serialization restore.
 
- Protected Member Functions inherited from agx::ElementaryConstraint
 ElementaryConstraint (agx::Bool enable, agx::UInt numRows, agx::RegularizationParameters *regParamsBuffer, agx::Real *lastForcesBuffer, agx::RangeReal *userBoundsBuffer)
 Construct given data.
 
virtual ~ElementaryConstraint ()
 Reference counted object, protected destructor.
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Protected Member Functions inherited from agxStream::Serializable
 Serializable ()
 Default constructor.
 
 Serializable (const Serializable &other)
 Copy constructor.
 
void generateUuid ()
 

Protected Attributes

Real m_currentAngle
 
Real m_violation
 
- Protected Attributes inherited from agx::ElementaryConstraintNData< 1, ConeLimitData >
ConeLimitData m_data
 Data.
 
- Protected Attributes inherited from agx::ElementaryConstraintN< N >
agx::RangeReal m_bounds [N]
 Bounds buffer.
 
agx::Real m_forces [N]
 Forces buffer.
 
agx::RegularizationParameters m_regParams [N]
 Regularization parameters buffer.
 
- Protected Attributes inherited from agx::ElementaryConstraint
agx::Bool m_enable
 enabled
 
agx::ref_ptr< agx::Referenced > m_internalData
 custom, internal data
 
agx::Real * m_lfs
 last forces
 
agx::ElementaryConstraint::NameType m_name
 name
 
agx::UInt m_numRows
 number of rows
 
agx::RegularizationParameters * m_rps
 regularization parameters
 
agx::RangeReal * m_ubs
 user bounds

 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Additional Inherited Members

- Public Types inherited from agx::ElementaryConstraint
typedef agx::Name NameType
 
typedef agx::VectorPOD< agx::ElementaryConstraint * > PtrContainer
 
typedef agx::Vector< agx::ref_ptr< agx::ElementaryConstraint > > RefContainer
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 

Detailed Description

Elementary secondary constraint to set a conic limit to a BallJoint.

Definition at line 1400 of file ElementaryConstraint.h.

Constructor & Destructor Documentation

◆ ConeLimit() [1/2]

agx::ConeLimit::ConeLimit ( const ConeLimitData &  data)

Constructor for ConeLimit.

Parameters
data- ConstraintAngleBasedData for this constraint

◆ ConeLimit() [2/2]

agx::ConeLimit::ConeLimit ( )
protected

Used during serialization restore.

◆ ~ConeLimit()

virtual agx::ConeLimit::~ConeLimit ( )
protectedvirtual

Reference counted object, protected destructor.

Member Function Documentation

◆ AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agx::ConeLimit::AGXSTREAM_DECLARE_SERIALIZABLE_BASE ( agx::ConeLimit  )

◆ create()

static agxStream::Serializable * agx::ConeLimit::create ( agxStream::InputArchive &  )
inlinestatic

Definition at line 1453 of file ElementaryConstraint.h.

◆ getBounds()

virtual agx::UInt agx::ConeLimit::getBounds ( agx::RangeReal *  bounds,
agx::UInt  row,
agx::Real  h 
) const
overrideprotectedvirtual

Returns the bounds of the Lagrange Multipliers (default (-inf, +inf)).

Note that the bounds buffer has to be provided by the caller.

Note
Dimension of the Lagrange Multipliers are Force * Time (argument h = time step length).
Parameters
bounds- bounds buffer
row- start row in bounds buffer bounds
h- current time step length
Returns
the number of rows used (= elements written) in the bounds buffer

Reimplemented from agx::ElementaryConstraint.

◆ getCurrentAngle()

Real agx::ConeLimit::getCurrentAngle ( ) const

Get the current angle between the centre of the cone limit and the axis limited by the constraint.

Returns
Current angle in radians

◆ getJacobian()

virtual UInt agx::ConeLimit::getJacobian ( Jacobian6DOFElement *  G,
UInt  numBlocks,
UInt  row,
GWriteState::Enum  writeState 
)
overrideprotectedvirtual

◆ getLimitAngles()

Vec2 agx::ConeLimit::getLimitAngles ( ) const

Get the cone limit angles, which defines how much a rod in a ball joint can rotate.

Returns
Vec2 containing the cone limits

◆ getViolation()

virtual agx::UInt agx::ConeLimit::getViolation ( agx::Real *  g,
agx::UInt  row 
)
overrideprotectedvirtual

Returns the violation of this elementary constraint.

Note that the violation buffer has to be provided by the caller.

Parameters
g- violation buffer
row- start row in violation buffer g
Returns
the number of rows used (= elements written) in violation buffer

Reimplemented from agx::ElementaryConstraint.

◆ isActive()

virtual Bool agx::ConeLimit::isActive ( ) const
overridevirtual
Returns
true if enabled and active at a bound, otherwise false

Reimplemented from agx::ElementaryConstraint.

◆ prepare()

virtual void agx::ConeLimit::prepare ( )
overrideprotectedvirtual

Prepare call.

After this call the elementary constraint may be activated.

Reimplemented from agx::ElementaryConstraint.

◆ safeCast()

static agx::ConeLimit * agx::ConeLimit::safeCast ( const agx::ElementaryConstraint *  coneLimit)
static

Utility cast method.

◆ setLimitAngles() [1/3]

void agx::ConeLimit::setLimitAngles ( Real  a1,
Real  a2 
)

Set the cone limit angles, which defines the max angle in two different directions.

The limit angles must be smaller than PI/2.

Parameters
a1- first angle (in radians) Limit
a2- second angle (in radians) limit

◆ setLimitAngles() [2/3]

void agx::ConeLimit::setLimitAngles ( Real  coneAngle)

Set the cone limit angles to the same angle, creating a circular limit.

The limit angles must be smaller than PI/2.

Parameters
coneAngle- angle limit, in radians

◆ setLimitAngles() [3/3]

void agx::ConeLimit::setLimitAngles ( Vec2  limit)

Set the cone limit angles, which defines the max angle in two different directions.

The limit angles must be smaller than PI/2.

Parameters
limit- Vec2 containing the two limits

Member Data Documentation

◆ m_currentAngle

Real agx::ConeLimit::m_currentAngle
protected

Definition at line 1472 of file ElementaryConstraint.h.

◆ m_violation

Real agx::ConeLimit::m_violation
protected

Definition at line 1471 of file ElementaryConstraint.h.


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