The class PointGravityField calculates a gravity which is uniform in magnitude over the entire space and directed from the given position outwards from origin. More...

#include <PointGravityField.h>

Inheritance diagram for agx::PointGravityField:

Public Member Functions
	PointGravityField (const Vec3 &center=Vec3(), Real gravityMagnitude=agx::GRAVITY_ACCELERATION)
	Constructor.

	AGXSTREAM_DECLARE_SERIALIZABLE_BASE (agx::PointGravityField)

virtual Vec3	calculateGravity (const Vec3 &position) const override
	Given `position`, a gravity acceleration will be calculated and returned.

virtual Task *	createParticleSystemTask () override
	Internal use.

virtual Task *	createRigidBodyTask () override
	Internal use.

Vec3	getCenter () const

Real	getGravity () const

void	setCenter (const Vec3 &center)

void	setGravity (const Real gravityMagnitude)
	Set the gravity direction/magnitude.

Public Member Functions inherited from agx::GravityField
	GravityField ()

	AGXSTREAM_DECLARE_ABSTRACT_SERIALIZABLE (agx::GravityField)

virtual agx::Vec3	calculateGravity (const agx::Vec3 &position) const =0
	Given `position`, a gravity acceleration will be calculated and returned.

virtual Task *	createParticleSystemTask ()=0
	Internal use.

virtual Task *	createRigidBodyTask ()=0
	Internal use.

Public Member Functions inherited from agx::Component
	Component (const agx::Name &name=agx::Name(), agx::Model model=agx::Component::ClassModel(), agx::Device device=nullptr)

virtual void	addObject (agx::Object *object, bool assignContext=true)
	Add an object to the component.

virtual String	autoComplete (const String &partialName, StringVector &matchingNames) const

virtual void	buildNavigationTree (agxJson::Value &eNode) const override

void	configure (Model *model)

virtual void	configure (TiXmlElement *eComponent) override

agx::Device *	getDevice ()

template<typename T >
T *	getDevice ()

const agx::Device *	getDevice () const

template<typename T >
const T *	getDevice () const

size_t	getNumObjects (const agx::Name &name) const

agx::Object *	getObject (const agx::Name &name, agx::Model *model, size_t index=0)

const agx::Object *	getObject (const agx::Name &name, agx::Model *model, size_t index=0) const

agx::Object *	getObject (const agx::Name &name, size_t index=0)

template<typename T >
T *	getObject (const agx::Name &name, size_t index=0)

const agx::Object *	getObject (const agx::Name &name, size_t index=0) const

template<typename T >
const T *	getObject (const agx::Name &name, size_t index=0) const

const agx::ObjectRefVector &	getObjects () const

template<typename T >
void	getObjects (agx::ObjectPtrVector &result, bool recursive=false) const
	Returns All child objects of a specified type in the result container.

void	getObjects (agx::ObjectPtrVector &result, const agx::Model *model, bool recursive=false) const

virtual Object *	getResourceImpl (const Path &path, agx::Model *model) override

virtual void	printSubtree () const override

void	printSubtree (std::ostream &stream, int depth=0) const

virtual void	rebind () override

void	removeAllObjects ()
	Remove all components.

virtual void	removeObject (agx::Object *object)
	Remove an object from the component.

void	removeObject (const agx::Name &name, size_t index=0)
	Remove an object with a specified name (and optional index) from the component.

virtual void	snapshot (TiXmlNode *eParent, const String &directory) const override

void	traverse (ComponentVisitor *)

void	traverse (const TraverseCallback &callback)

Public Member Functions inherited from agx::Object
	Object (const Name &name=Name(), Model *model=Object::ClassModel())

void	addListener (EventListener *listener)

virtual void	buildNavigationTree (agxJson::Value &eNode) const

virtual void	configure (TiXmlElement *)

agx::String	fullName () const

agx::String	fullPath () const

agx::String	fullPath (const agx::Object *root) const

template<typename T >
T *	getAutoScopedResource (const agx::Path &path)

template<typename T >
const T *	getAutoScopedResource (const agx::Path &path) const

agx::Object *	getAutoScopedResource (const agx::Path &path, agx::Model *model=nullptr)

const agx::Object *	getAutoScopedResource (const agx::Path &path, agx::Model *model=nullptr) const

agx::Object *	getContext ()

template<typename T >
T *	getContext ()

const agx::Object *	getContext () const

template<typename T >
const T *	getContext () const

agx::UInt32	getId () const

const agx::Name &	getImplementationName () const

agx::Model *	getModel ()

const agx::Model *	getModel () const

const agx::Name &	getName () const

agx::Object *	getNextSibling ()

const agx::Object *	getNextSibling () const

agx::Path	getPath () const

agx::Path	getPath (const agx::Object *root) const

template<typename T >
T *	getResource (const agx::Path &path)

template<typename T >
const T *	getResource (const agx::Path &path) const

agx::Object *	getResource (const agx::Path &path, agx::Model *model=nullptr)

const agx::Object *	getResource (const agx::Path &path, agx::Model *model=nullptr) const

virtual agx::Object *	getResourceImpl (const agx::Path &path, agx::Model *model)

agx::Object *	getRootContext ()

const agx::Object *	getRootContext () const

bool	hasListener (EventListener *listener)

bool	hasParent (const agx::Object *node) const

bool	isUnique () const

virtual void	printSubtree () const

virtual void	rebind ()

void	removeListener (EventListener *listener)

virtual void	save (TiXmlElement *) const

virtual void	setContext (agx::Object *context)

void	setId (UInt32 id)

void	setModel (agx::Model *model)
	Set the object model (handled automatically).

void	setName (const agx::Name &name)
	Set the name of the object.

virtual void	snapshot (TiXmlNode *, const String &) const

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 Public Member Functions inherited from agx::Component
static Component *	_load (TiXmlElement eComponent, Device device)

static agx::Model *	ClassModel ()

static Component *	load (const Path &path, const Name &implementation, Device *device, const Path &_namespace=Path())

static Component *	load (const String &path, const Path &_namespace=Path())

static Component *	load (const String &path, Device *device, const Path &_namespace=Path())

static Component *	load (TiXmlElement eComponent, Device device)

Static Public Member Functions inherited from agx::Object
static agx::Model *	ClassModel ()

static agx::String	generateName (const agx::String &bindPath)

static const HashSet< Object * > &	getActiveObjects ()

static bool	getEnableRebind ()
	Should rebinding be allowed? Right now a global setting.

static Object *	load (const String &path, Device *device, const String &type, const String &attribute, const String &value)

template<typename T >
static T *	load (const String &path, Device *device, const String &type, const String &attribute, const String &value)

static Object *	load (const String &path, Device *device, const String &type="", size_t instance=0)

template<typename T >
static T *	load (const String &path, Device *device, const String &type="", size_t instance=0)

static void	load (const String &path, Device *device, ObjectPtrVector &loadedObjects)

static Object *	load (TiXmlElement eObject, Device device)

template<typename T >
static T *	load (TiXmlElement eObject, Device device)

static TiXmlDocument	openDocument (const String &path)

static void	setEnableRebind (bool flag)
	Sets if rebinding of objects should be allowed (Right now a global setting).

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
virtual	~PointGravityField ()

Protected Member Functions inherited from agx::GravityField
virtual	~GravityField ()
	Destructor.

virtual void	restore (agxStream::InputArchive &in) override

virtual void	store (agxStream::OutputArchive &out) const override

Protected Member Functions inherited from agx::Component
virtual	~Component ()

String	expandAutoCompletionMatch (const String &query, const StringVector &matchingNames) const

void	setDevice (Device *device)

Protected Member Functions inherited from agx::Object
virtual	~Object ()

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 ()

Additional Inherited Members
Public Types inherited from agx::Component
typedef Event2< Component , Object >	ObjectEvent
	Event when adding removing child objects.

typedef Callback1< Object * >	TraverseCallback

Public Types inherited from agx::Object
typedef agx::observer_ptr< const Event >	EventConstObserver

typedef agx::ref_ptr< const Event >	EventConstRef

typedef agx::observer_ptr< Event >	EventObserver

typedef agx::Vector< EventObserver >	EventObserverVector

typedef agx::VectorPOD< Event * >	EventPtrVector

typedef agx::ref_ptr< Event >	EventRef

typedef agx::Vector< EventRef >	EventRefVector

Public Attributes inherited from agx::Component
ObjectEvent	addObjectEvent

ObjectEvent	removeObjectEvent

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.

Protected Attributes inherited from agx::Referenced
Mutex	m_mutex

ObserverContainer	m_observers

AtomicValue	m_refCount

Detailed Description

The class PointGravityField calculates a gravity which is uniform in magnitude over the entire space and directed from the given position outwards from origin.

Inwards for negative magnitudes.

Definition at line 31 of file PointGravityField.h.

Constructor & Destructor Documentation

◆ PointGravityField()

agx::PointGravityField::PointGravityField	(	const Vec3 &	center = `Vec3()`,
		Real	gravityMagnitude = `agx::GRAVITY_ACCELERATION`
	)

Constructor.

Parameters

center	- The center of the gravity field
gravityMagnitude	the magnitude for the PointGravity (direction is calculated later based in pos)

◆ ~PointGravityField()

virtual agx::PointGravityField::~PointGravityField ( )

protectedvirtual

Member Function Documentation

◆ AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

agx::PointGravityField::AGXSTREAM_DECLARE_SERIALIZABLE_BASE ( agx::PointGravityField )

◆ calculateGravity()

Vec3 agx::PointGravityField::calculateGravity ( const Vec3 & position ) const

inlineoverridevirtual

Given position, a gravity acceleration will be calculated and returned.

Parameters

position - The position at which the acceleration will be given.

Returns: The calculated acceleration at position.

Implements agx::GravityField.

Definition at line 80 of file PointGravityField.h.

References agx::ref_ptr< T >::get(), and agx::Vec3T< T >::normalize().

◆ create()

static agxStream::Serializable * agx::PointGravityField::create ( agxStream::InputArchive & )

inlinestatic

Definition at line 68 of file PointGravityField.h.

◆ createParticleSystemTask()

virtual Task * agx::PointGravityField::createParticleSystemTask ( )

overridevirtual

Internal use.

Implements agx::GravityField.

◆ createRigidBodyTask()

virtual Task * agx::PointGravityField::createRigidBodyTask ( )

overridevirtual

Internal use.

Implements agx::GravityField.

◆ getCenter()

Vec3 agx::PointGravityField::getCenter ( ) const

inline

Returns: the direction/magnitude

Definition at line 93 of file PointGravityField.h.

◆ getGravity()

Real agx::PointGravityField::getGravity ( ) const

inline

Returns: the direction/magnitude

Definition at line 88 of file PointGravityField.h.

References agx::ref_ptr< T >::get().

◆ setCenter()

void agx::PointGravityField::setCenter ( const Vec3 & center )

◆ setGravity()

void agx::PointGravityField::setGravity ( const Real gravityMagnitude )

Set the gravity direction/magnitude.

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

PointGravityField.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PointGravityField()

◆ ~PointGravityField()

Member Function Documentation

◆ AGXSTREAM_DECLARE_SERIALIZABLE_BASE()

◆ calculateGravity()

◆ create()

◆ createParticleSystemTask()

◆ createRigidBodyTask()

◆ getCenter()

◆ getGravity()

◆ setCenter()

◆ setGravity()