PolygonProxy Class Reference

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

Inheritance diagram for PolygonProxy:

List of all members.

Public Member Functions
	PolygonProxy (const PolygonProxyBase &p)
PolygonProxy &	operator= (const PolygonProxy &p)
PolygonProxy &	operator= (const PolygonProxyBase &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 polygon to the scene.
DelayedDispatch	add (const ObjectProxyBase &parent, const std::string &name, NameConflictPolicy conflict_policy=AUTO_ENUMERATE_ON_CONFLICT)
	Add a polygon to the scene.

---

Detailed Description

Proxy class used to add and manipulate polygons.

Usage example:

 peekabot::PolygonProxy p;
 p.add(client, "root.poly");

 // Add vertices to form a pentagon
 for( int i = 0; i < 5; ++i )
   p.add_vertex( cosf(i*2*M_PI/5), sinf(i*2*M_PI/5), 0 );

---

Member Function Documentation

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

Add a polygon to the scene.

Adds a zero-vertex polygon the scene at the given path and assigns the proxy to line to it. If an object already exists at the given path the outcome is governed by conflict_policy.

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 polygon to the scene.

Adds a zero-vertex polygon with the given name under the the object referred to by parent and assigns the proxy to line to it. If an object already exists at the given path the outcome is governed by conflict_policy.

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/PolygonProxy.hh
• src/client/proxies/PolygonProxy.cc