| SoRectangleScreenDrawer Class |
Interactively draws a rectangle in normalized screen space.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.DrawersSoScreenDrawer
OIV.Inventor.DrawersSoPolyLineScreenDrawer
OIV.Inventor.DrawersSoRectangleScreenDrawer
Namespace: OIV.Inventor.Drawers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoRectangleScreenDrawer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoRectangleScreenDrawer | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoScreenDrawer.) |
| Clear | Convenience method to clear the points in the line. |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoScreenDrawer.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoScreenDrawer.) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoScreenDrawer.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoScreenDrawer.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | Traversal routine for OIV.Inventor.Actions.SoHandleEventAction - this will call action->setHandled() if the event is handled. |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | 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. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| NormalizePoint | Returns position normalized in range -1..1 relative to specified viewport. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoScreenDrawer.) |
| Reset | Clears the points in the line and resets internal state to initial values. |
| Search | (Inherited from SoNode.) |
| Set | 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. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | color | Color of line. |
| doCCW | Make the line counter-clockwise when it is finalized. |
| isClosed | Close the line during display (connect last point to first point). |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| linePattern | Stipple pattern. |
| linePatternScaleFactor | Stipple pattern scale factor. |
| lineWidth | Width of lines. |
| method | Method to create rectangle. |
| point | Points of line. |
| sceneGraph | Scene graph to render. |
| simplificationThreshold | Threshold (in pixels) used to simplify line when it is finished. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Events| Name | Description | |
|---|---|---|
 | OnFinish | Event raised when the line is finished. |
| OnMove | Event raised during polyline drawing. |
| OnStart | Event raised when starting to draw a polyline. |
RemarksThis 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