modelLoadRequest.h

Go to the documentation of this file.

/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file modelLoadRequest.h
 * @author drose
 * @date 2006-08-29
 */

#ifndef MODELLOADREQUEST_H
#define MODELLOADREQUEST_H

#include "pandabase.h"

#include "asyncTask.h"
#include "filename.h"
#include "loaderOptions.h"
#include "pandaNode.h"
#include "pointerTo.h"
#include "loader.h"
#include "nodePath.h"

/**
 * A class object that manages a single asynchronous model load request.
 * Create a new ModelLoadRequest, and add it to the loader via load_async(),
 * to begin an asynchronous load.
 */
class EXPCL_PANDA_PGRAPH ModelLoadRequest : public AsyncTask {
public:
  ALLOC_DELETED_CHAIN(ModelLoadRequest);

PUBLISHED:
  explicit ModelLoadRequest(const std::string &name,
                            const Filename &filename,
                            const LoaderOptions &options,
                            Loader *loader);

  INLINE const Filename &get_filename() const;
  INLINE const LoaderOptions &get_options() const;
  INLINE Loader *get_loader() const;

  INLINE bool is_ready() const;
  INLINE PandaNode *get_model() const;

  MAKE_PROPERTY(filename, get_filename);
  MAKE_PROPERTY(options, get_options);
  MAKE_PROPERTY(loader, get_loader);

protected:
  virtual DoneStatus do_task();

private:
  Filename _filename;
  LoaderOptions _options;
  PT(Loader) _loader;

public:
  static TypeHandle get_class_type() {
    return _type_handle;
  }
  static void init_type() {
    AsyncTask::init_type();
    register_type(_type_handle, "ModelLoadRequest",
                  AsyncTask::get_class_type());
    }
  virtual TypeHandle get_type() const {
    return get_class_type();
  }
  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}

private:
  static TypeHandle _type_handle;
};

#include "modelLoadRequest.I"

#endif