AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxWire::AreaDefinition Class Referenceabstract

AreaDefinition that specifies an area in which an eye node can move in an EyeNodeArea constraint. More...

#include <EyeNodeArea.h>

+ Inheritance diagram for agxWire::AreaDefinition:

Public Member Functions

 AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agxWire::AreaDefinition)
 
agxWire::EyeNode * getEyeNode ()
 
agx::Vec3 getLocalCenter ()
 
agx::Vec3 getLocalDirection ()
 
virtual bool getOverlap (agx::Vec3 &pointOnBoundary, agx::Vec3 &dirTowardsCenter, agx::Real &overlap, agx::Vec3 &tangent)=0
 Callback from EyeNodeArea to fetch information about the boundary.
 
agx::RigidBody * getRigidBody ()
 
virtual void render (agxRender::RenderManager *, float) const
 Optional debug rendering of this boundary.
 
- 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.
 

Protected Member Functions

 AreaDefinition (agx::RigidBody *rb, agx::Vec3 localCenter, agx::Vec3 localDirection, agxWire::EyeNode *eyeNode)
 
virtual ~AreaDefinition ()
 
virtual void restore (agxStream::InputArchive &in) override
 
virtual void store (agxStream::OutputArchive &out) const override
 
- 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

agx::observer_ptr< agx::RigidBody > m_body
 
agx::observer_ptr< agxWire::EyeNode > m_eyeNode
 
agx::Vec3 m_localCenter
 
agx::Vec3 m_localDirection
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Additional Inherited Members

- 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.
 
- 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

AreaDefinition that specifies an area in which an eye node can move in an EyeNodeArea constraint.

It also calculates if the eye node position violates that boundary.

Definition at line 30 of file EyeNodeArea.h.

Constructor & Destructor Documentation

◆ AreaDefinition()

agxWire::AreaDefinition::AreaDefinition ( agx::RigidBody *  rb,
agx::Vec3  localCenter,
agx::Vec3  localDirection,
agxWire::EyeNode *  eyeNode 
)
protected

◆ ~AreaDefinition()

virtual agxWire::AreaDefinition::~AreaDefinition ( )
inlineprotectedvirtual

Definition at line 78 of file EyeNodeArea.h.

Member Function Documentation

◆ AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE()

agxWire::AreaDefinition::AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE ( agxWire::AreaDefinition  )

◆ getEyeNode()

agxWire::EyeNode * agxWire::AreaDefinition::getEyeNode ( )
Returns
the eye node associated with the area.

◆ getLocalCenter()

agx::Vec3 agxWire::AreaDefinition::getLocalCenter ( )
Returns
the center of the area in body coordinates.

◆ getLocalDirection()

agx::Vec3 agxWire::AreaDefinition::getLocalDirection ( )
Returns
the direction of the area that is perpendicular to the area plane in body coordinates.

◆ getOverlap()

virtual bool agxWire::AreaDefinition::getOverlap ( agx::Vec3 &  pointOnBoundary,
agx::Vec3 &  dirTowardsCenter,
agx::Real &  overlap,
agx::Vec3 &  tangent 
)
pure virtual

Callback from EyeNodeArea to fetch information about the boundary.

If the point is inside the boundary, return false from this callback. If outside, return true. Mandatory info when active are pointOnBoundary, dirTowardsCenter and overlap. If length of tangent is zero, viscous friction like constraint for sliding along the boundary is ignored.

Parameters
pointOnBoundary- point on boundary surface given in world coordinates
dirTowardsCenter- normalized vector pointing out the way out from the overlap
overlap- overlap from boundary surface, negative value
tangent- orthogonal vector to dirTowardsCenter (boundary tangent) to enable friction along boundary surface
Returns
true if the boundary is violated (i.e., overlap < 0) - otherwise false

Implemented in agxWire::CircularAreaDefinition, and agxWire::ConvexAreaDefinition.

◆ getRigidBody()

agx::RigidBody * agxWire::AreaDefinition::getRigidBody ( )
Returns
the rigid body associated with the area.

◆ render()

virtual void agxWire::AreaDefinition::render ( agxRender::RenderManager *  ,
float   
) const
inlinevirtual

Optional debug rendering of this boundary.

Reimplemented in agxWire::ConvexAreaDefinition.

Definition at line 71 of file EyeNodeArea.h.

◆ restore()

virtual void agxWire::AreaDefinition::restore ( agxStream::InputArchive &  in)
overrideprotectedvirtual

◆ store()

virtual void agxWire::AreaDefinition::store ( agxStream::OutputArchive &  out) const
overrideprotectedvirtual

Member Data Documentation

◆ m_body

agx::observer_ptr< agx::RigidBody > agxWire::AreaDefinition::m_body
protected

Definition at line 85 of file EyeNodeArea.h.

◆ m_eyeNode

agx::observer_ptr< agxWire::EyeNode > agxWire::AreaDefinition::m_eyeNode
protected

Definition at line 88 of file EyeNodeArea.h.

◆ m_localCenter

agx::Vec3 agxWire::AreaDefinition::m_localCenter
protected

Definition at line 86 of file EyeNodeArea.h.

◆ m_localDirection

agx::Vec3 agxWire::AreaDefinition::m_localDirection
protected

Definition at line 87 of file EyeNodeArea.h.


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