Proxy class used to add and manipulate grids. More...
Public Member Functions | |
| GridProxy (GridProxyBase &p) | |
| GridProxy & | operator= (const GridProxy &p) |
| GridProxy & | operator= (const GridProxyBase &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, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT) |
| Add a grid to the scene. | |
| DelayedDispatch | add (const ObjectProxyBase &parent, const std::string &name, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT) |
| Add a grid to the scene. | |
Detailed Description
Proxy class used to add and manipulate grids.
The extent of the grids is manipulated by changing the scale, and altering the number of segments the grids is comprised of.
Member Function Documentation
| DelayedDispatch add | ( | PeekabotClient & | client, | |
| const std::string & | path, | |||
| NameConflictPolicy | conflict_policy = AUTO_ENUMERATE_ON_CONFLICT | |||
| ) |
Add a grid to the scene.
Adds a regular 1-segment grid to the scene at the given path and assigns the proxy to refer to it. If an object already exists at the given path the outcome is governed by conflict_policy.
Use set_grid_type(), set_segment_count() and set_central_angle() to adjust the grid parameters once it's been created.
- Parameters:
-
path The path where the object will be added, including the name of the object. conflict_policy Determines how name conflicts are handled.
| DelayedDispatch add | ( | const ObjectProxyBase & | parent, | |
| const std::string & | name, | |||
| NameConflictPolicy | conflict_policy = AUTO_ENUMERATE_ON_CONFLICT | |||
| ) |
Add a grid to the scene.
Adds a regular 1-segment grid with the given name under the object referred to by parent and assigns the proxy to refer to it. If an object already exists at the given path the outcome is governed by conflict_policy.
Use set_grid_type(), set_segment_count() and set_central_angle() to adjust the grid parameters once it's been created.
- Parameters:
-
parent The parent under which the object will be added. name The name to assign to the created object. 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:
- src/client/proxies/GridProxy.hh
- src/client/proxies/GridProxy.cc
