+++ /dev/null
--- Created on: 1993-06-22
--- Created by: Jean Louis FRENKEL
--- Copyright (c) 1993-1999 Matra Datavision
--- Copyright (c) 1999-2012 OPEN CASCADE SAS
---
--- The content of this file is subject to the Open CASCADE Technology Public
--- License Version 6.5 (the "License"). You may not use the content of this file
--- except in compliance with the License. Please obtain a copy of the License
--- at http://www.opencascade.org and read it completely before using this file.
---
--- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
--- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
---
--- The Original Code and all software distributed under the License is
--- distributed on an "AS IS" basis, without warranty of any kind, and the
--- Initial Developer hereby disclaims all such warranties, including without
--- limitation, any warranties of merchantability, fitness for a particular
--- purpose or non-infringement. Please see the License for the specific terms
--- and conditions governing the rights and limitations under the License.
-
-
--- Modified: TCL G002A, 28-11-00, new section "inquire methods"
-
-
-class PolylineMarker from Graphic2d inherits VectorialMarker from Graphic2d
-
- ---Version:
-
- ---Purpose: The primitive PolylineMarker
- -- Every marker takes a reference point as an argument in
- -- its constructor. CircleMarker and EllipsMarker take
- -- another point as the center and PolylineMarker takes the
- -- first point of its list as its origin.
- -- The coordinates of the centre or origin point are offsets
- -- with respect to the reference point.
-
-
-uses
- Drawer from Graphic2d,
- Array1OfReal from TColStd,
- Array1OfShortReal from TShort,
- GraphicObject from Graphic2d,
- Array1OfVertex from Graphic2d,
- Length from Quantity,
- FStream from Aspect,
- IFStream from Aspect,
- IFStream from Aspect
-raises
-
- PolylineDefinitionError from Graphic2d,
- OutOfRange from Standard
-
-is
- -------------------------
- -- Category: Constructors
- -------------------------
-
- Create (aGraphicObject: GraphicObject from Graphic2d;
- aXPosition, aYPosition: Length from Quantity;
- aListVertex: Array1OfVertex from Graphic2d)
- returns mutable PolylineMarker from Graphic2d
- ---Level: Public
- ---Purpose: Creates a polyline marker.
- -- The reference point is <aXPosition>, <aYPosition>
- -- Warning: Raises an error if the length of the polyline
- -- is less than 2 points.
- raises PolylineDefinitionError from Graphic2d;
- ---Category: Constructors
-
- Create (aGraphicObject: GraphicObject from Graphic2d;
- aXPosition, aYPosition: Length from Quantity;
- aListX: Array1OfReal from TColStd;
- aListY: Array1OfReal from TColStd)
- returns mutable PolylineMarker from Graphic2d
- ---Level: Public
- ---Purpose: Creates a polyline marker.
- -- The reference point is <aXPosition>, <aYPosition>
- -- Warning: Raises an error if the length of the polyline
- -- is less than 2 points or if length of <aListX>
- -- is not equal to length of <aListY>.
- raises PolylineDefinitionError from Graphic2d;
- ---Category: Constructors
-
- -------------------------------------
- ---Category: Inquire methods
- -------------------------------------
-
- Length( me ) returns Integer from Standard;
- ---Level: Public
- ---Purpose: Returns the number of points of
- -- the polyline marker
- ---Category: Inquiry method
-
- Values( me; aRank: Integer from Standard;
- X,Y: out Length from Quantity )
- ---Level: Public
- ---Purpose: Returns the point of rank <aRank>
- -- from the polyline marker
- ---Trigger: Raises OutOfRange if <aRank> is <1 or >Length()
- raises OutOfRange from Standard;
- ---Category: Inquiry method
-
- --------------------------------------
- -- Category: Draw and Pick
- --------------------------------------
-
- Draw (me : mutable; aDrawer: Drawer from Graphic2d)
- is static protected;
- ---Level: Internal
- ---Purpose: Draws the polyline <me>.
-
- DrawElement( me : mutable; aDrawer: Drawer from Graphic2d;
- anIndex: Integer from Standard)
- is redefined protected;
- ---Level: Internal
- ---Purpose: Draws edge <anIndex> of the polyline marker <me>.
-
- DrawVertex( me : mutable; aDrawer: Drawer from Graphic2d;
- anIndex: Integer from Standard)
- is redefined protected;
- ---Level: Internal
- ---Purpose: Draws vertex <anIndex> of the polyline marker <me>.
-
- Pick (me : mutable;
- X, Y: ShortReal from Standard;
- aPrecision: ShortReal from Standard;
- aDrawer: Drawer from Graphic2d)
- returns Boolean from Standard is static protected;
- ---Level: Internal
- ---Purpose: Returns Standard_True if the polyline <me> is picked,
- -- Standard_False if not.
-
- ----------------------------------------------------------------------
-
- Save( me; aFStream: in out FStream from Aspect ) is virtual;
- Retrieve(myclass; anIFStream: in out IFStream from Aspect;
- aGraphicObject: GraphicObject from Graphic2d);
-
-fields
-
- myX: Array1OfShortReal from TShort;
- myY: Array1OfShortReal from TShort;
-
-end PolylineMarker from Graphic2d;