Public Member Functions

ModelProxy Class Reference

Proxy class used to add and manipulate models. More...

Inheritance diagram for ModelProxy:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ModelProxy (const ModelProxyBase &p)
ModelProxyoperator= (const ModelProxy &p)
ModelProxyoperator= (const ModelProxyBase &p)
DelayedDispatch assign (const ObjectProxyBase &p)
DelayedDispatch assign (PeekabotClient &client, const std::string &path)
DelayedDispatch assign (const ObjectProxyBase &parent, const std::string &rel_path)
DelayedDispatch add (PeekabotClient &client, const std::string &path, const std::string &filename, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT)
 Add a model to the scene.
DelayedDispatch add (const ObjectProxyBase &parent, const std::string &name, const std::string &filename, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT)
 Add a model to the scene.

Detailed Description

Proxy class used to add and manipulate models.


Member Function Documentation

DelayedDispatch add ( PeekabotClient client,
const std::string &  path,
const std::string &  filename,
NameConflictPolicy  conflict_policy = AUTO_ENUMERATE_ON_CONFLICT 
)

Add a model to the scene.

Adds a model to the scene at the given path and assigns the proxy to point to it. If an object already exists at the given path the outcome is governed by conflict_policy.

The model file to load must reside on the peekabot server, not the client.

Parameters:
path The path where the object will be added, including the name of the object.
filename The (server-side) path to the model file.
conflict_policy Determines how name conflicts are handled.
DelayedDispatch add ( const ObjectProxyBase parent,
const std::string &  name,
const std::string &  filename,
NameConflictPolicy  conflict_policy = AUTO_ENUMERATE_ON_CONFLICT 
)

Add a model to the scene.

Adds a model with the given name under the the object referred to by parent and assigns the proxy to point to it. If an object already exists at the given path the outcome is governed by conflict_policy.

The model file to load must reside on the peekabot server, not the client.

Parameters:
parent The parent under which the object will be added.
name The name to assign to the created object.
filename The (server-side) path to the model file.
conflict_policy Determines how name conflicts are handled.
DelayedDispatch assign ( PeekabotClient client,
const std::string &  path 
)

Assign the proxy to the object with the given path.

Parameters:
client The client to use for this proxy.
path The path of the object in the peeakbot scene.
DelayedDispatch assign ( const ObjectProxyBase parent,
const std::string &  rel_path 
)

Assign the proxy to the object with the given parent and name.

Parameters:
parent The parent of the object referred to by name.
rel_path The path of the object, relative the parent object, to assign this proxy to.
DelayedDispatch assign ( const ObjectProxyBase p  ) 

Upcast and assign from another proxy.

If the object pointed to by p is not of compatible type, the assignment will fail and subsequent operations performed on the proxy will fail.


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