Files
OCCT/src/ShapeExtend/ShapeExtend_Explorer.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

102 lines
4.7 KiB
Plaintext
Executable File

-- Created on: 1998-06-03
-- Created by: data exchange team
-- Copyright (c) 1998-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.
class Explorer from ShapeExtend
---Purpose: This class is intended to
-- explore shapes and convert different representations
-- (list, sequence, compound) of complex shapes. It provides tools for:
-- - obtaining type of the shapes in context of TopoDS_Compound,
-- - exploring shapes in context of TopoDS_Compound,
-- - converting different representations of shapes (list, sequence, compound).
uses
Shape from TopoDS,
ShapeEnum from TopAbs,
HSequenceOfShape from TopTools,
ListOfShape from TopTools
raises
TypeMismatch from Standard
is
Create returns Explorer from ShapeExtend;
---Purpose: Creates an object Explorer
CompoundFromSeq (me; seqval: HSequenceOfShape)
returns Shape from TopoDS;
---Purpose: Converts a sequence of Shapes to a Compound
SeqFromCompound (me; comp: Shape from TopoDS; expcomp: Boolean)
returns HSequenceOfShape;
---Purpose: Converts a Compound to a list of Shapes
-- if <comp> is not a compound, the list contains only <comp>
-- if <comp> is Null, the list is empty
-- if <comp> is a Compound, its sub-shapes are put into the list
-- then if <expcomp> is True, if a sub-shape is a Compound, it
-- is not put to the list but its sub-shapes are (recursive)
ListFromSeq (me; seqval: HSequenceOfShape;
lisval: in out ListOfShape from TopTools;
clear: Boolean = Standard_True);
---Purpose: Converts a Sequence of Shapes to a List of Shapes
-- <clear> if True (D), commands the list to start from scratch
-- else, the list is cumulated
SeqFromList (me; lisval: ListOfShape)
returns HSequenceOfShape from TopTools;
---Purpose: Converts a List of Shapes to a Sequence of Shapes
ShapeType (me; shape: Shape from TopoDS; compound: Boolean)
returns ShapeEnum;
---Purpose: Returns the type of a Shape: true type if <compound> is False
-- If <compound> is True and <shape> is a Compound, iterates on
-- its items. If all are of the same type, returns this type.
-- Else, returns COMPOUND. If it is empty, returns SHAPE
-- For a Null Shape, returns SHAPE
SortedCompound (me; shape: Shape from TopoDS; type: ShapeEnum;
explore: Boolean; compound: Boolean)
returns Shape from TopoDS;
---Purpose: Builds a COMPOUND from the given shape.
-- It explores the shape level by level, according to the
-- <explore> argument. If <explore> is False, only COMPOUND
-- items are explored, else all items are.
-- The following shapes are added to resulting compound:
-- - shapes which comply to <type>
-- - if <type> is WIRE, considers also free edges (and makes wires)
-- - if <type> is SHELL, considers also free faces (and makes shells)
-- If <compound> is True, gathers items in compounds which
-- correspond to starting COMPOUND,SOLID or SHELL containers, or
-- items directly contained in a Compound
DispatchList (me; list: HSequenceOfShape;
vertices, edges, wires, faces, shells, solids, compsols, compounds:
in out HSequenceOfShape);
---Purpose: Dispatches starting list of shapes according to their type,
-- to the appropriate resulting lists
-- For each of these lists, if it is null, it is firstly created
-- else, new items are appended to the already existing ones
end Explorer;