SoRectangleScreenDrawer Class Reference
[Drawers]

Interactively draws a rectangle in normalized screen space. More...

#include <Inventor/drawers/SoRectangleScreenDrawer.h>

Inheritance diagram for SoRectangleScreenDrawer:

List of all members.

Public Types
enum	CreationMethod {   CORNER_CORNER,   CENTER_CORNER }
Public Member Functions
virtual SoType	getTypeId () const
	SoRectangleScreenDrawer ()
virtual void	reset ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFEnum	method

---

Detailed Description

Interactively draws a rectangle in normalized screen space.

This class can be used to interactively draw a rectangle on screen.

When the rectangle is finished, an event is raised to notify the application (see SoPolyLineScreenDrawer::onFinish ). Points are returned as normalized coordinates in the range -1..1, which is conveniently the default view volume for an SoOrthographicCamera node.

The line color and simplification threshold are specified by fields in the parent class SoPolyLineScreenDrawer.

Please see SoPolyLineScreenDrawer for general notes and code example.

Rectangle specific notes:

• The rectangle can be specified by 2 corner points (default) or by a center point and one corner point (see CreationMethod).

• The rectangle points are always delivered upper-left corner first, then counter-clockwise.

• The simplificationThreshold field does not apply to this node. A rectangle always has four points.

• The isClosed field does apply to this node (but FALSE is not very useful).

• If user finishes a rectangle, then the next click will automatically clear the polyline (begin a new rectangle).

• SbEventHandlers:
  • OnStart : Triggered on LeftMouseDown input event.
  • OnMove : Triggered on MouseMove input events (after Start).
  • OnFinish : Triggered on LeftMouseUp input event.

[C++]
Screen drawer classes must be initialized by calling SoInteraction::init(). High level viewer init methods, like SoWin::init(), automatically do this. However, if the application is calling SoDB::init() directly, then it is usually necessary to also call SoInteraction::init() before using the screen drawer classes.

USAGE

• Press left mouse and drag to draw the rectangle.
• Release to finish it.
• Press Escape to cancel.

FILE FORMAT/DEFAULT

RectangleScreenDrawer {

point	[]
color	1 0 0
simplificationThreshold	0
isClosed	TRUE
method	CORNER_CORNER

}

SEE ALSO

SoEllipseScreenDrawer, SoLassoScreenDrawer, SoPolyLineScreenDrawer, SoPolygonScreenDrawer,

See related examples:

CustomScreenDrawer, MedicalFreeHandCutting

---

Member Enumeration Documentation

enum SoRectangleScreenDrawer::CreationMethod

Methods to create rectangle.

Enumerator:

CORNER_CORNER	Initial point is a corner, current point is a corner.
CENTER_CORNER	Initial point is the center, current point is a corner.

---

Constructor & Destructor Documentation

SoRectangleScreenDrawer::SoRectangleScreenDrawer

(

)

Constructor.

---

Member Function Documentation

static SoType SoRectangleScreenDrawer::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoPolyLineScreenDrawer.

virtual SoType SoRectangleScreenDrawer::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoPolyLineScreenDrawer.

virtual void SoRectangleScreenDrawer::reset

(

)

[virtual]

Clears the points in the line and resets internal state to initial values. This cancels any current drawing. Since Open Inventor 10.7.3

Reimplemented from SoPolyLineScreenDrawer.

---

Member Data Documentation

SoSFEnum SoRectangleScreenDrawer::method

Method to create rectangle.

Use enum CreationMethod. Default is CORNER_CORNER.

---

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

• Inventor/drawers/SoRectangleScreenDrawer.h