Click or drag to resize
SoRectangleScreenDrawer Class

Interactively draws a rectangle in normalized screen space.

Inheritance Hierarchy

Namespace: OIV.Inventor.Drawers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoRectangleScreenDrawer : SoPolyLineScreenDrawer

The SoRectangleScreenDrawer type exposes the following members.

Constructors
  NameDescription
Public methodSoRectangleScreenDrawer

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoScreenDrawer.)
Public methodClear

Convenience method to clear the points in the line.

(Inherited from SoPolyLineScreenDrawer.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoScreenDrawer.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoScreenDrawer.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoScreenDrawer.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Inherited from SoScreenDrawer.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent

Traversal routine for OIV.Inventor.Actions.SoHandleEventAction - this will call action->setHandled() if the event is handled.

(Inherited from SoScreenDrawer.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodNormalizePoint

Returns position normalized in range -1..1 relative to specified viewport.

(Inherited from SoScreenDrawer.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoScreenDrawer.)
Public methodReset

Clears the points in the line and resets internal state to initial values.

(Overrides SoPolyLineScreenDrawerReset.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertycolor

Color of line.

(Inherited from SoPolyLineScreenDrawer.)
Public propertydoCCW

Make the line counter-clockwise when it is finalized.

(Inherited from SoPolyLineScreenDrawer.)
Public propertyisClosed

Close the line during display (connect last point to first point).

(Inherited from SoPolyLineScreenDrawer.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertylinePattern

Stipple pattern.

(Inherited from SoPolyLineScreenDrawer.)
Public propertylinePatternScaleFactor

Stipple pattern scale factor.

(Inherited from SoPolyLineScreenDrawer.)
Public propertylineWidth

Width of lines.

(Inherited from SoPolyLineScreenDrawer.)
Public propertymethod

Method to create rectangle.

Public propertypoint

Points of line.

(Inherited from SoPolyLineScreenDrawer.)
Public propertysceneGraph

Scene graph to render.

(Inherited from SoScreenDrawer.)
Public propertysimplificationThreshold

Threshold (in pixels) used to simplify line when it is finished.

(Inherited from SoPolyLineScreenDrawer.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Events
  NameDescription
Public eventOnFinish

Event raised when the line is finished.

(Inherited from SoPolyLineScreenDrawer.)
Public eventOnMove

Event raised during polyline drawing.

(Inherited from SoPolyLineScreenDrawer.)
Public eventOnStart

Event raised when starting to draw a polyline.

(Inherited from SoPolyLineScreenDrawer.)
Top
Remarks

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 OIV.Inventor.Drawers.SoPolyLineScreenDrawer.onFinish ). Points are returned as normalized coordinates in the range -1..1, which is conveniently the default view volume for an OIV.Inventor.Nodes.SoOrthographicCamera node.

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

Please see OIV.Inventor.Drawers.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 OIV.Inventor.Drawers.SoRectangleScreenDrawer.CreationMethods).

  • 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.

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