PickBuffer Class Reference

---

Detailed Description

This class provides access to a picking buffer returned from ToolContent::GetPickBuffer.

See also:

ToolContext::GetPickBuffer

Since:

10.0 (2012)

#include <xsi_pickbuffer.h>

Inheritance diagram for PickBuffer:

List of all members.

Public Member Functions
	PickBuffer ()
	~PickBuffer ()
	PickBuffer (const CRef &in_ref)
	PickBuffer (const PickBuffer &in_obj)
bool	IsA (siClassID in_ClassID) const
siClassID	GetClassID () const
PickBuffer &	operator= (const PickBuffer &in_obj)
PickBuffer &	operator= (const CRef &in_ref)
CRef	GetObjectAtPosition (LONG x, LONG y) const
LONG	GetComponentIndexAtPosition (LONG x, LONG y) const

---

Constructor & Destructor Documentation

PickBuffer

(

)

Default constructor.

~PickBuffer

(

)

Default destructor.

PickBuffer

(

const CRef &

in_ref

)

Constructor.

Parameters:

in_ref

constant reference object.

PickBuffer

(

const PickBuffer &

in_obj

)

Copy constructor.

Parameters:

in_obj

constant class object.

---

Member Function Documentation

bool IsA

(

siClassID

in_ClassID

)

const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:

in_ClassID

class type.

Returns:

true if the class is compatible, false otherwise.

Reimplemented from CBase.

siClassID GetClassID

(

)

const [virtual]

Returns the type of the API class.

Returns:

The class type.

Implements CBase.

PickBuffer& operator=

(

const PickBuffer &

in_obj

)

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:

in_obj

constant class object.

Returns:

The new Image object.

PickBuffer& operator=

(

const CRef &

in_ref

)

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:

in_ref

constant class object.

Returns:

The new Image object.

CRef GetObjectAtPosition	(	LONG	x,
		LONG	y
	)		const

Retrieve object at the specified view coordinates.

Parameters:

x	View X coordinate in pixels.
y	View Y coordinate in pixels.

Returns:

Object at specified view coordinates. If no object is found an invalid reference is returned.

LONG GetComponentIndexAtPosition	(	LONG	x,
		LONG	y
	)		const

Retrieve component index at the specified view coordinates. For a pick buffer generated using siObjectFilter the component index will return 0 if there is an object at the specified location. This can be used as a quick way to test for objects.

Parameters:

x	View X coordinate in pixels.
y	View Y coordinate in pixels.

Returns:

Component index or -1 if no component at specified coordinates.

---

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

• xsi_pickbuffer.h