Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
PreparedGraphicsObjects::EnqueuedObject Class Referencefinal

This is a handle to an enqueued object, from which the result can be obtained upon completion. More...

#include "preparedGraphicsObjects.h"

Inheritance diagram for PreparedGraphicsObjects::EnqueuedObject:
AsyncFuture TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

Public Member Functions

 EnqueuedObject (PreparedGraphicsObjects *pgo, TypedWritableReferenceCount *object)
 Creates a new future for the given object. More...
 
virtual bool cancel () final
 Cancels the pending preparation request. More...
 
virtual TypeHandle force_init_type ()
 
TypedWritableReferenceCountget_object ()
 
SavedContextget_result ()
 
virtual TypeHandle get_type () const
 
void notify_removed ()
 Called by PreparedGraphicsObjects to indicate that the preparation request has been cancelled. More...
 
void set_result (SavedContext *result)
 Indicates that the preparation request is done. More...
 
- Public Member Functions inherited from AsyncFuture
 AsyncFuture ()
 Initializes the future in the pending state. More...
 
virtual ~AsyncFuture ()
 Destroys the future. More...
 
bool add_waiting_task (AsyncTask *task)
 Indicates that the given task is waiting for this future to complete. More...
 
bool cancelled () const
 Returns true if the future was cancelled. More...
 
bool done () const
 Returns true if the future is done or has been cancelled. More...
 
const std::string & get_done_event () const
 
TypedObjectget_result () const
 Returns this future's result. More...
 
void get_result (TypedObject *&ptr, ReferenceCount *&ref_ptr) const
 Returns this future's result as a pair of TypedObject, ReferenceCount pointers. More...
 
virtual bool is_task () const
 
void notify_done (bool clean_exit)
 Schedules the done callbacks. More...
 
virtual void output (std::ostream &out) const
 
void set_done_event (const std::string &done_event)
 
void set_result (std::nullptr_t)
 Sets this future's result. More...
 
void set_result (TypedObject *result)
 
void set_result (TypedReferenceCount *result)
 
void set_result (TypedWritableReferenceCount *result)
 
void set_result (const EventParameter &result)
 
void set_result (TypedObject *ptr, ReferenceCount *ref_ptr)
 Sets this future's result. More...
 
void wait ()
 Waits until the future is done. More...
 
void wait (double timeout)
 Waits until the future is done, or until the timeout is reached. More...
 
- Public Member Functions inherited from TypedReferenceCount
 TypedReferenceCount (const TypedReferenceCount &copy)
 
void operator= (const TypedReferenceCount &copy)
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from AsyncFuture
static AsyncFuturegather (Futures futures)
 Creates a new future that returns `done()` when all of the contained futures are done. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_object
 
- Public Attributes inherited from AsyncFuture
 get_done_event
 Returns the event name that will be triggered when the future finishes. More...
 
 set_done_event
 Sets the event name that will be triggered when the future finishes. More...
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Additional Inherited Members

- Public Types inherited from AsyncFuture
typedef pvector< PT(AsyncFuture)> Futures
 

Detailed Description

This is a handle to an enqueued object, from which the result can be obtained upon completion.

Definition at line 167 of file preparedGraphicsObjects.h.

Constructor & Destructor Documentation

◆ EnqueuedObject()

PreparedGraphicsObjects::EnqueuedObject::EnqueuedObject ( PreparedGraphicsObjects pgo,
TypedWritableReferenceCount object 
)

Creates a new future for the given object.

Definition at line 1438 of file preparedGraphicsObjects.cxx.

Member Function Documentation

◆ cancel()

bool PreparedGraphicsObjects::EnqueuedObject::cancel ( )
finalvirtual

Cancels the pending preparation request.

Has no effect if the preparation is already complete or was already cancelled.

Reimplemented from AsyncFuture.

Definition at line 1468 of file preparedGraphicsObjects.cxx.

◆ notify_removed()

void PreparedGraphicsObjects::EnqueuedObject::notify_removed ( )

Called by PreparedGraphicsObjects to indicate that the preparation request has been cancelled.

Definition at line 1458 of file preparedGraphicsObjects.cxx.

◆ set_result()

void PreparedGraphicsObjects::EnqueuedObject::set_result ( SavedContext result)

Indicates that the preparation request is done.

Definition at line 1447 of file preparedGraphicsObjects.cxx.


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