scene_object.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_H
#define RVE_RENDER_CLIENT_SCENE_OBJECT_H

#include "forwards.h"

#include <rve_common/uuid.h>
#include <rve_common/forwards.h>

#include <vector>
#include <string>

namespace rve_render_client
{

class Scene;

class SceneObject
{
protected:
  struct ContextInfo
  {
    Scene* scene;
    ClientContext* context;
    std::vector<InterfaceHandle> interfaces;

    bool operator==(const ContextInfo& rhs)
    {
      return scene == rhs.scene && context == rhs.context;
    }
  };
  typedef std::vector<ContextInfo> V_ContextInfo;

public:
  void create(Scene* scene, ClientContext* context);
  void destroy(Scene* scene, ClientContext* context);

  virtual void doCreate(ContextInfo& context) = 0;
  virtual void doDestroy(ContextInfo& context) = 0;

  typedef std::vector<rve_common::UUID> V_UUID;
  virtual void getContextDependencies(V_UUID& deps) = 0;

  void removeFromAll();

  virtual bool addToRegistry( rve_common::RegistryPtr registry, rve_common::RegistrantWPtr registrant ) = 0;
  virtual bool removeFromRegistry( rve_common::RegistryPtr registry, rve_common::RegistrantWPtr registrant ) = 0;

protected:

  const rve_common::UUID& getSceneID(Scene* scene);

  template<typename T>
  T* getProxy(const ContextInfo& info, uint32_t proxy_index)
  {
    return static_cast<T*>(getProxy(info, proxy_index));
  }

  V_ContextInfo& getContexts() { return contexts_; }

  uint32_t addProxy(const std::string& name);

  template<typename F>
  void forEachContext(F f)
  {
    V_ContextInfo::iterator it = contexts_.begin();
    V_ContextInfo::iterator end = contexts_.end();
    for (; it != end; ++it)
    {
      ContextInfo& info = *it;
      f(info);
    }
  }

  template<typename P, typename F>
  void multiplex(F f, uint32_t proxy_index)
  {
    V_ContextInfo::iterator it = contexts_.begin();
    V_ContextInfo::iterator end = contexts_.end();
    for (; it != end; ++it)
    {
      ContextInfo& info = *it;
      P* proxy = getProxy<P>(info, proxy_index);
      f(proxy, getSceneID(info.scene));
    }
  }

private:

  void* getProxy(const ContextInfo& info, uint32_t proxy_index);
  void lookupProxy(ContextInfo& info, const std::string& name);

  V_ContextInfo contexts_;
  std::vector<std::string> proxies_;
};

void destroySceneObject(SceneObject* obj);

}

#endif // RVE_RENDER_CLIENT_SCENE_OBJECT_H