Base class for all proxies to vertex-based objects. More...
Public Types | |
| typedef peekabot::client::VertexSet | VertexSet |
Public Member Functions | |
| VertexBasedProxyBase (const VertexBasedProxyBase &p) | |
| DelayedDispatch | set_vertices (const VertexSet &vertices) |
| Set the vertices of the object. | |
| DelayedDispatch | add_vertices (const VertexSet &vertices) |
| Add one or more vertices to the object. | |
| DelayedDispatch | set_vertices (const ColoredVertexSet &vertices) |
| DelayedDispatch | add_vertices (const ColoredVertexSet &vertices) |
| DelayedDispatch | add_vertex (float x, float y, float z) PEEKABOT_DEPRECATED |
| Add a single vertex to the object. | |
| DelayedDispatch | clear_vertices () |
| Remove all vertices of the remote object. | |
| DelayedDispatch | set_max_vertices (boost::uint32_t n) |
| Automatically keep the number of vertices in the object below or at the specified value. | |
| DelayedDispatch | set_vertex_overflow_policy (VertexOverflowPolicy overflow_policy) |
| Set the policy for resolving vertex overflows. | |
Detailed Description
Base class for all proxies to vertex-based objects.
Member Function Documentation
| DelayedDispatch add_vertex | ( | float | x, | |
| float | y, | |||
| float | z | |||
| ) |
Add a single vertex to the object.
- Remarks:
- If you're adding several vertices, using add_vertices(const VertexSet &) is a lot more efficient.
- Deprecated:
- Deprecated in peekabot 0.8. Use VertexSet in conjunction with add_vertices() instead.
| DelayedDispatch add_vertices | ( | const VertexSet & | vertices | ) |
Add one or more vertices to the object.
- Parameters:
-
vertices The vertices to add to the object.
| DelayedDispatch add_vertices | ( | const ColoredVertexSet & | vertices | ) |
Add one or more vertices to the object.
- Parameters:
-
vertices The vertices to add to the object.
| DelayedDispatch set_max_vertices | ( | boost::uint32_t | n | ) |
Automatically keep the number of vertices in the object below or at the specified value.
This is very useful when visualizing, for example, the path that a robot has traversed, since it might grow very large if left unchecked. Vertex-based objects whose vertices are updated continuously consume significant CPU resources when they grow large.
Setting the max vertices option to 0 (the default) disables this functionality. The behaviour when the vertices overflow is controlled by set_vertex_overflow_policy().
| DelayedDispatch set_vertex_overflow_policy | ( | VertexOverflowPolicy | overflow_policy | ) |
Set the policy for resolving vertex overflows.
Depending on the value supplied, the vertices are either cleared, truncated or truncated to half their size, where the latter is the default. When truncating, "older" vertices are removed first.
- See also:
- set_max_vertices()
| DelayedDispatch set_vertices | ( | const ColoredVertexSet & | vertices | ) |
Set the vertices of the object.
- Parameters:
-
vertices The vertices to set the remote object's vertices to.
| DelayedDispatch set_vertices | ( | const VertexSet & | vertices | ) |
Set the vertices of the object.
- Parameters:
-
vertices The vertices to set the remote object's vertices to.
The documentation for this class was generated from the following files:
- src/client/proxies/VertexBasedProxy.hh
- src/client/proxies/VertexBasedProxy.cc
