AGX Dynamics 2.41.1.2
Loading...
Searching...
No Matches
agxUtil::HeightFieldGenerator Class Reference

#include <HeightFieldGenerator.h>

+ Inheritance diagram for agxUtil::HeightFieldGenerator:

Public Member Functions

 HeightFieldGenerator ()
 Default constructor.
 
- 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.
 
Referencedoperator= (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.
 

Static Public Member Functions

static agxCollide::HeightFieldcreateHeightFieldFromFile (const agx::String &filename, agx::Real sizeX, agx::Real sizeY, agx::Real low, agx::Real high, agx::Real bottomMargin=agx::Real(1))
 
static agxCollide::HeightFieldcreateHeightFieldFromImage (agxIO::Image *image, agx::Real sizeX, agx::Real sizeY, agx::Real low, agx::Real high, agx::Real bottomMargin=agx::Real(1))
 
- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 

Protected Member Functions

virtual ~HeightFieldGenerator ()
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 

Additional Inherited Members

- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandlergetDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

Definition at line 36 of file HeightFieldGenerator.h.

Constructor & Destructor Documentation

◆ HeightFieldGenerator()

agxUtil::HeightFieldGenerator::HeightFieldGenerator ( )
inline

Default constructor.

Definition at line 41 of file HeightFieldGenerator.h.

◆ ~HeightFieldGenerator()

virtual agxUtil::HeightFieldGenerator::~HeightFieldGenerator ( )
protectedvirtual

Member Function Documentation

◆ createHeightFieldFromFile()

static agxCollide::HeightField * agxUtil::HeightFieldGenerator::createHeightFieldFromFile ( const agx::String filename,
agx::Real  sizeX,
agx::Real  sizeY,
agx::Real  low,
agx::Real  high,
agx::Real  bottomMargin = agx::Real(1) 
)
static
Parameters
filename- Path to an image which will be read as a height map.
sizeX- World size in the x dimension
sizeY- World size in the y dimension
low- The lowest height in the z dimension, maps to the lowest value in the image
high- The highest height in the z dimension, maps to the highest value in the image
bottomMarginHow deep is the HeightField under its lowest point?
Returns
a HeightField shape with extents in X/Y and height values along Z

◆ createHeightFieldFromImage()

static agxCollide::HeightField * agxUtil::HeightFieldGenerator::createHeightFieldFromImage ( agxIO::Image image,
agx::Real  sizeX,
agx::Real  sizeY,
agx::Real  low,
agx::Real  high,
agx::Real  bottomMargin = agx::Real(1) 
)
static
Parameters
image- Pointer to an image used for creating the height field
sizeX- World size in the x dimension
sizeY- World size in the y dimension
low- The lowest height in the z dimension, maps to the lowest value in the image
high- The highest height in the z dimension, maps to the highest value in the image
bottomMarginHow deep is the HeightField under its lowest point?
Returns
a HeightField shape with extents in X/Y and height values along Z

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