AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxSensor::ICameraActiveIllumination Class Referenceabstract

Base type for active illumination sources synchronized with a camera. More...

#include <CameraActiveIllumination.h>

+ Inheritance diagram for agxSensor::ICameraActiveIllumination:

Public Member Functions

 ICameraActiveIllumination ()=default
 Default constructor.
 
virtual CameraActiveIlluminationRef createCameraActiveIlluminationProxy ()=0
 
virtual agx::Real getFlashDuration () const =0
 
virtual const agx::AffineMatrix4x4 & getTransform () const =0
 
virtual void setFlashDuration (agx::Real flash=std::numeric_limits< agx::Real >::infinity())=0
 Set the duration of the active illumination flash.
 
- Public Member Functions inherited from agxSensor::ISystemNodeProxy
virtual bool addNotification (SystemNodeProxy &proxy)
 Called when this system node has been added to a sensor environment.
 
virtual void cleanup (SystemNodeProxy &proxy)=0
 The sensor environment is being put down, clean everything.
 
virtual void complete (SystemNodeProxy &proxy)
 Complete the execution of this system, finishing the integration forward in time.
 
virtual SystemNodeProxyRef createProxy ()=0
 
virtual void execute (SystemNodeProxy &proxy, const CallbackData &data)
 Execute this system, integrating it data.dt forward in time.
 
virtual bool onAdd (SystemNodeProxy &proxy, agx::Referenced &instance)
 Called when an object has been added to the sensor environment.
 
virtual void onChildAdded (SystemNodeProxy &proxy, SystemNode &child)
 Called when child has been added to this parent.
 
virtual void onChildRemoved (SystemNodeProxy &proxy, SystemNode &child)
 Called when child has been removed from this parent.
 
virtual bool onRemove (SystemNodeProxy &proxy, agx::Referenced &instance)
 Called when an object has been removed from the sensor environment.
 
virtual void removeNotification (SystemNodeProxy &proxy)
 Called when this system node is being removed from a sensor environment.
 
virtual void result (SystemNodeProxy &proxy, const CallbackData &data)
 If necessary assemble, and fetch results related to this system node after a step by data.dt has been completed.
 
virtual void synchronize (SystemNodeProxy &proxy, const CallbackData &data)
 Synchronization from the main thread.
 
virtual void synchronizeGraphics (SystemNodeProxy &proxy, const agxRender::RenderManager &renderManager)
 At the very end of a step, synchronize any graphics related aspects of the system node.
 
- 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.
 

Additional Inherited Members

- Public Types inherited from agxSensor::ISystemNodeProxy
using CallbackData = SystemNode::CallbackData
 
- 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 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 ()
 
- 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

Base type for active illumination sources synchronized with a camera.

Definition at line 36 of file CameraActiveIllumination.h.

Constructor & Destructor Documentation

◆ ICameraActiveIllumination()

agxSensor::ICameraActiveIllumination::ICameraActiveIllumination ( )
default

Default constructor.

Member Function Documentation

◆ createCameraActiveIlluminationProxy()

virtual CameraActiveIlluminationRef agxSensor::ICameraActiveIllumination::createCameraActiveIlluminationProxy ( )
pure virtual
Returns
new, unique, camera active illumination (proxy) of this implementation

Implemented in agxSensor::CameraPointLight, and agxSensor::CameraSpotlight.

◆ getFlashDuration()

virtual agx::Real agxSensor::ICameraActiveIllumination::getFlashDuration ( ) const
pure virtual
Returns
the duration of the active illumination flash.

Implemented in agxSensor::CameraPointLight, and agxSensor::CameraSpotlight.

◆ getTransform()

virtual const agx::AffineMatrix4x4 & agxSensor::ICameraActiveIllumination::getTransform ( ) const
pure virtual
Returns
relative transform of the active illumination source to the camera

Implemented in agxSensor::CameraPointLight, and agxSensor::CameraSpotlight.

◆ setFlashDuration()

virtual void agxSensor::ICameraActiveIllumination::setFlashDuration ( agx::Real  flash = std::numeric_limits< agx::Real >::infinity())
pure virtual

Set the duration of the active illumination flash.

Default is infinity, representing a constantly illuminating lamp.

Note
This duration is assumed to fall during the capture frame of the camera, and represents the t0.1 flash duration value.
Parameters
flash- the flash duration to set

Implemented in agxSensor::CameraPointLight, and agxSensor::CameraSpotlight.


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