scene_object_collection.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef RVE_RENDER_CLIENT_SCENE_OBJECT_COLLECTION_H
#define RVE_RENDER_CLIENT_SCENE_OBJECT_COLLECTION_H

#include <rve_common/forwards.h>

#include "forwards.h"
#include "scene_object.h"

#include <set>

namespace rve_render_client
{

class SceneObjectCollection : public SceneObject
{
public:
  void addObject(const SceneObjectPtr& obj);
  void removeObject(const SceneObjectPtr& obj);
  virtual bool addToRegistry( rve_common::RegistryPtr registry, rve_common::RegistrantWPtr registrant );
  virtual bool removeFromRegistry( rve_common::RegistryPtr registry, rve_common::RegistrantWPtr registrant );

protected:
  SceneObjectCollection() {}
  virtual void doCreate(ContextInfo& info);
  virtual void doDestroy(ContextInfo& info);
  virtual void getContextDependencies(V_UUID& deps);

  typedef std::set<SceneObjectPtr> S_SceneObject;
  S_SceneObject objects_;

  friend SceneObjectCollectionPtr createSceneObjectCollection(Scene*);
  friend SceneObjectCollectionPtr createSceneObjectCollection();
  friend void destroySceneObjectCollection(SceneObjectCollection*);

private:
  rve_common::RegistryWPtr registry_;
  rve_common::RegistrantWPtr registrant_;
};

SceneObjectCollectionPtr createSceneObjectCollection(Scene* scene);
SceneObjectCollectionPtr createSceneObjectCollection();

} // namespace rve_render_client

#endif // RVE_RENDER_CLIENT_SCENE_OBJECT_COLLECTION_H