[occt.git] / src / Graphic3d / Graphic3d_Group.cdl

-- Created on: 1991-09-06
-- Created by: NW,JPB,CAL
-- Copyright (c) 1991-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.

--      27/09/97 ; PCT : add manual control of  textures
--              11/97 ; CAL : ajout polyline par 2 points
--      16/06/2000 : ATS: Study G005 - Group store presentations of it's objects in field
--                        MyListOfPArray to avoid deletion of handle-manipulating 
--                        primitives.
class Group from Graphic3d inherits TShared
    
        ---Version:

        ---Purpose: This class allows the definition of groups
        --     of primitives inside of graphic objects (presentations).
        --     A group contains the primitives and attributes
        --     for which the range is limited to this group.
        --     The primitives of a group can be globally suppressed.
        --
        --      There are two main group usage models:
        --
        --        1) Non-modifiable, or unbounded, group ('black box'). 
        --           Developers can repeat a sequence of 
        --           SetPrimitivesAspect() with AddPrimitiveArray() methods arbitrary number of times
        --           to define arbitrary number of primitive "blocks" each having individual apect values.
        --           Any modification of such a group is forbidden, as aspects and primitives are mixed 
        --           in memory without any high-level logical structure, and any modification is very likely to result
        --           in corruption of the group internal data.
        --           It is necessary to recreate such a group as a whole when some attribute should be changed.
        --           (for example, in terms of AIS it is necessary to re-Compute() the whole presentation each time).
        --        2) Bounded group. Developers should specify the necessary group aspects with help of
        --           SetGroupPrimitivesAspect() and then add primitives to the group.
        --           Such a group have simplified organization in memory (a single block of attributes
        --           followed by a block of primitives) and therefore it can be modified, if it is necessary to
        --           change parameters of some aspect that has already been set, using methods:
        --           IsGroupPrimitivesAspectSet() to detect which aspect was set for primitives;
        --           GroupPrimitivesAspect() to read current aspect values
        --           and SetGroupPrimitivesAspect() to set new values.
        -- 
        --        Developers are strongly recommended to take all the above into account when filling Graphic3d_Group
        --        with aspects and primitives and choose the group usage model beforehand out of application needs.

        ---Warning:
        ---References:
    
    uses
    
        Array1OfInteger             from TColStd,
        Array1OfReal                from TColStd,
        HArray1OfByte               from TColStd,
    
        ExtendedString              from TCollection,
    
        PlaneAngle                  from Quantity,
    
        Array1OfEdge                from Aspect,
        Edge                        from Aspect,
    
    	GroupAspect	            from Graphic3d,
        AspectLine3d                from Graphic3d,
        AspectMarker3d              from Graphic3d,
        AspectText3d                from Graphic3d,
        AspectFillArea3d            from Graphic3d,
        HorizontalTextAlignment     from Graphic3d,
        CBitFields4                 from Graphic3d,
        CGroup                      from Graphic3d,
        GraphicDriver               from Graphic3d,
        Structure                   from Graphic3d,
        TextPath                    from Graphic3d,
        Vector                      from Graphic3d,
        Array1OfVertex              from Graphic3d,
        Array2OfVertex              from Graphic3d,
        Vertex                      from Graphic3d,
        VerticalTextAlignment       from Graphic3d, 
        ArrayOfPrimitives           from Graphic3d,
        ListOfPArray                from Graphic3d,
        TransModeFlags              from Graphic3d,
        CBounds                     from Graphic3d
    
    raises
    
        GroupDefinitionError        from Graphic3d,
        PickIdDefinitionError       from Graphic3d,
    OutOfRange          from Standard
    
    is
        Create ( AStructure : Structure from Graphic3d )
            returns mutable Group from Graphic3d;
        ---Level: Public
        ---Purpose: Creates a group in the structure <AStructure>.
    
        ---------------------------------------------------
        -- Category: Methods to modify the class definition
        ---------------------------------------------------
    
        Clear ( me  : mutable;
                theUpdateStructureMgr : Boolean from Standard = Standard_True )
            is static;
        ---Level: Public
        ---Purpose: Supress all primitives and attributes of <me>.
        --          To clear group without update in Graphic3d_StructureManager
        --          pass Standard_False as <theUpdateStructureMgr>. This
        --          used on context and viewer destruction, when the pointer
        --          to structure manager in Graphic3d_Structure could be 
        --          already released (pointers are used here to avoid handle 
        --          cross-reference);
        ---Category: Methods to modify the class definition
    
        Destroy ( me    : mutable )
            is static;
        ---Level: Public
        ---Purpose: Supress the group <me> in the structure.
        ---Category: Methods to modify the class definition
        ---C++: alias ~
    
        Remove ( me : mutable )
            is static;
        ---Level: Public
        ---Purpose: Supress the group <me> in the structure.
        --  Warning: No more graphic operations in <me> after this call.
        ---Category: Methods to modify the class definition

        --SetTransformPersistence( me     : mutable;
        --                         AFlag  : TransModeFlags from Graphic3d )
        ---Level: Public
    ---Purpose: Modifies the current modelling transform persistence (pan, zoom or rotate)
        --is static;

    --TransformPersistence( me )
    --      returns TransModeFlags from Graphic3d
        ---Level: Public
    ---Purpose: Get the current modelling transform persistence (pan, zoom or rotate)
        --is static;
    
        SetGroupPrimitivesAspect ( me   : mutable )
            is static;
        ---Level: Public
        ---Purpose: Removes the context for all the line primitives
        --      of the group.
        ---Category: Methods to modify the class definition
    
        SetGroupPrimitivesAspect ( me   : mutable;
                                   CTX  : AspectLine3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the context for all the line primitives
        --      of the group.
        ---Category: Methods to modify the class definition
    
        SetGroupPrimitivesAspect ( me   : mutable;
                                   CTX  : AspectFillArea3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the context for all the face primitives
        --      of the group.
        ---Category: Methods to modify the class definition
    
        SetGroupPrimitivesAspect ( me   : mutable;
                                   CTX  : AspectText3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the context for all the text primitives
        --      of the group.
        ---Category: Methods to modify the class definition
    
        SetGroupPrimitivesAspect ( me   : mutable;
                                   CTX  : AspectMarker3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the context for all the marker primitives
        --      of the group.
        ---Category: Methods to modify the class definition
    
        SetPrimitivesAspect ( me    : mutable;
                              CTX   : AspectLine3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the current context of the group to give
        --      another aspect for all the line primitives created
        --      after this call in the group.
        ---Category: Methods to modify the class definition
    
        SetPrimitivesAspect ( me    : mutable;
                              CTX   : AspectFillArea3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the current context of the group to give
        --      another aspect for all the face primitives created
        --      after this call in the group.
        ---Category: Methods to modify the class definition
    
        SetPrimitivesAspect ( me    : mutable;
                              CTX   : AspectText3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the current context of the group to give
        --      another aspect for all the text primitives created
        --      after this call in the group.
        ---Category: Methods to modify the class definition
    
        SetPrimitivesAspect ( me    : mutable;
                              CTX   : AspectMarker3d from Graphic3d )
            is static;
        ---Level: Public
        ---Purpose: Modifies the current context of the group to give
        --      another aspect for all the marker primitives created
        --      after this call in the group.
        ---Category: Methods to modify the class definition
    
        SetMinMaxValues ( me                : mutable;
                          XMin, YMin, ZMin  : Real from Standard;
                          XMax, YMax, ZMax  : Real from Standard )
            is static;
        ---Level: Public
        ---Purpose: Sets the coordinates of the boundary box of the
        --      group <me>.
        ---Category: Methods to modify the class definition

        -----------------------------------
        -- Category: Methods to create Text
        -----------------------------------
    
        --------------------------------------------
        -- Summary of Texts                       --
        --                                        --
        -- Text  has  geometric  and nongeometric --
        -- attributes.                            --
        --                                        --
        -- The geometric text attributes are :    --
        --                                        --
        --  Character Height.                 --
        --  Character Up Vector.              --
        --  Text Path.                        --
        --  Text Alignment Horizontal.        --
        --  Text Alignment Vertical.          --
        --                                        --
        -- The nongeometric text attributes are : --
        --                                        --
        --  Text Font.                        --
        --  Character Spacing.                --
        --  Character Expansion Factor.       --
        --  Text Color.                       --
        --------------------------------------------
    
        Text (  me  : mutable;
            AText   : CString from Standard;
            APoint  : Vertex from Graphic3d;
            AHeight : Real from Standard;
            AAngle  : PlaneAngle from Quantity;
            ATp : TextPath from Graphic3d;
            AHta    : HorizontalTextAlignment from Graphic3d;
            AVta    : VerticalTextAlignment from Graphic3d;
            EvalMinMax  : Boolean from Standard = Standard_True )
            is static;
        ---Level: Public
        ---Purpose: Creates the string <AText> at position <APoint>.
        --      The 3D point of attachment is projected. The text is
        --      written in the plane of projection.
        --      The attributes are given with respect to the plane of
        --      projection.
        --      AHeight : Height of text.
        --            (Relative to the Normalized Projection
        --              Coordinates (NPC) Space).
        --      AAngle  : Orientation of the text
        --            (with respect to the horizontal).
        ---Category: Methods to create Text
    
        Text ( me   : mutable;
               AText    : CString from Standard;
               APoint   : Vertex from Graphic3d;
               AHeight  : Real from Standard;
               EvalMinMax   : Boolean from Standard = Standard_True )
            is static;
        ---Level: Public
        ---Purpose: Creates the string <AText> at position <APoint>.
        --      The 3D point of attachment is projected. The text is
        --      written in the plane of projection.
        --      The attributes are given with respect to the plane of
        --      projection.
        --      AHeight : Height of text.
        --            (Relative to the Normalized Projection
        --              Coordinates (NPC) Space).
        --      The other attributes have the following default values:
        --      AAngle  : PI / 2.
        --      ATp     : TP_RIGHT
        --      AHta    : HTA_LEFT
        --      AVta    : VTA_BOTTOM
        ---Category: Methods to create Text
    
        Text (  me          : mutable;
                AText       : ExtendedString from TCollection;
                APoint      : Vertex from Graphic3d;
                AHeight     : Real from Standard;
                AAngle      : PlaneAngle from Quantity;
                ATp         : TextPath from Graphic3d;
                AHta        : HorizontalTextAlignment from Graphic3d;
                AVta        : VerticalTextAlignment from Graphic3d;
                EvalMinMax  : Boolean from Standard = Standard_True )
            is static;
        ---Level: Internal
        ---Purpose: Creates the string <AText> at position <APoint>.
        --      The 3D point of attachment is projected. The text is
        --      written in the plane of projection.
        --      The attributes are given with respect to the plane of
        --      projection.
        --      AHeight : Height of text.
        --            (Relative to the Normalized Projection
        --              Coordinates (NPC) Space).
        --      AAngle  : Orientation of the text
        --            (with respect to the horizontal).
        ---Category: Methods to create Text
    
        Text ( me           : mutable;
               AText        : ExtendedString from TCollection;
               APoint       : Vertex from Graphic3d;
               AHeight      : Real from Standard;
               EvalMinMax   : Boolean from Standard = Standard_True )
            is static;
        ---Level: Internal
        ---Purpose: Creates the string <AText> at position <APoint>.
        --      The 3D point of attachment is projected. The text is
        --      written in the plane of projection.
        --      The attributes are given with respect to the plane of
        --      projection.
        --      AHeight : Height of text.
        --            (Relative to the Normalized Projection
        --              Coordinates (NPC) Space).
        --      The other attributes have the following default values:
        --      AAngle  : PI / 2.
        --      ATp     : TP_RIGHT
        --      AHta    : HTA_LEFT
        --      AVta    : VTA_BOTTOM
        ---Category: Methods to create Text
    
        ---------------------------------------
        ---Category: Methods to create Triangle
        ---------------------------------------

    AddPrimitiveArray( me      : mutable;
                       elem    : ArrayOfPrimitives from Graphic3d;
          EvalMinMax: Boolean from Standard = Standard_True );
        ---Level: Public
    ---Purpose: Adds an array of primitives for display

    UserDraw ( me           : mutable;
               AnObject     : Address from Standard; 
               EvalMinMax   : Boolean from Standard = Standard_True; 
               ContainsFacet: Boolean from Standard = Standard_False
    )
    ---Level: Public
    ---Purpose: Creates an UserDraw primitive
    --  Category: Methods to create UserDraw
    --  Warning: Raises GroupDefinitionError if ...
    raises GroupDefinitionError from Graphic3d is static;

        ----------------------------
        -- Category: Inquire methods
        ----------------------------

        IsGroupPrimitivesAspectSet ( me;
                    theAspect : GroupAspect from Graphic3d )
            returns Boolean from Standard
            is static;
        ---Level: Public
        ---Purpose: Returns TRUE if aspect is set for the group.
        ---Category: Inquire methods

    	GroupPrimitivesAspect ( me;
    				CTXL	: AspectLine3d from Graphic3d;
    				CTXT	: AspectText3d from Graphic3d;
    				CTXM	: AspectMarker3d from Graphic3d;
    				CTXF	: AspectFillArea3d from Graphic3d )
    		is static;
    	---Level: Public
    	---Purpose: Returns the context of all the primitives of the group.
    	---Category: Inquire methods
    
    	PrimitivesAspect ( me;
    			   CTXL	: AspectLine3d from Graphic3d;
    			   CTXT	: AspectText3d from Graphic3d;
    			   CTXM	: AspectMarker3d from Graphic3d;
    			   CTXF	: AspectFillArea3d from Graphic3d )
    		is static;
    	---Level: Public
    	---Purpose: Returns the last inserted context in the group <me>
    	--	    foreach kind of primitives.
    	---Category: Inquire methods

        ContainsFacet ( me )
            returns Boolean from Standard
            is static;
        ---Level: Internal
        ---Purpose: Returns Standard_True if the group <me> contains
        --      Polygons, Triangles or Quadrangles.
        ---Category: Inquire methods
    
        IsDeleted ( me )
            returns Boolean from Standard
            is static;
        ---Level: Public
        ---Purpose: Returns Standard_True if the group <me> is deleted.
        --      <me> is deleted after the call Remove (me) or the
        --      associated structure is deleted.
        ---Category: Inquire methods
    
        IsEmpty ( me )
            returns Boolean from Standard
            is static;
        ---Level: Public
        ---Purpose: Returns Standard_True if the group <me> is empty.
        ---Warning: A group is empty if the MinMaxValues method returns :
        --      XMin = YMin = ZMin = RealFirst ().
        --      XMax = YMax = ZMax = RealLast ().
        ---Category: Inquire methods
    
        MinMaxValues ( me;
                       XMin, YMin, ZMin : out Real from Standard;
                       XMax, YMax, ZMax : out Real from Standard )
            is static;
        ---Level: Public
        ---Purpose: Returns the coordinates of the boundary box of the
        --      group <me>.
        ---Warning: If the group <me> is empty then :
        --      XMin = YMin = ZMin = RealFirst ().
        --      XMax = YMax = ZMax = RealLast ().
        ---Category: Inquire methods
    
        Structure ( me )
            returns mutable Structure from Graphic3d
            is static;
        ---Level: Public
        ---Purpose: Returns the structure containing the group <me>.
        ---Category: Inquire methods
    
        ----------------------------
        -- Category: Private methods
        ----------------------------
        
        MinMaxCoord ( me;
                      XMin, YMin, ZMin : out Real from Standard;
                      XMax, YMax, ZMax : out Real from Standard )
            is static private;
        ---Level: Internal
        ---Purpose: Returns the extreme coordinates found in the group.
        ---Warning: If the group <me> is empty then :
        --      XMin = YMin = ZMin = RealFirst ().
        --      XMax = YMax = ZMax = RealLast ().
        ---Category: Private methods
    
        Update ( me )
            is static private;
        ---Level: Internal
        ---Purpose: Calls the Update method of the StructureManager which
        --      contains the associated Structure of the Group <me>.
        ---Category: Private methods
    
    fields
    
    --
    -- Class    :   Graphic3d_Group
    --
    -- Purpose  :   Declaration of variables specific to groups
    --          of primitives.
    --
    -- Reminder :   A group is defined in a structure
    --          It acts as the smallest editable entity.
    
        -- the associated C structure 
        MyCGroup        :   CGroup from Graphic3d;
    
        -- the graphic driver used
        MyGraphicDriver     :   GraphicDriver from Graphic3d;
    
        -- the state of the different contexts for primitives
        MyCBitFields        :   CBitFields4 from Graphic3d;
    
        -- the structure contains the group
        MyPtrStructure      :   Address from Standard;
    
        -- the min-max
    MyBounds                :       CBounds from Graphic3d;

    MyListOfPArray          :   ListOfPArray from Graphic3d;

    MyMarkArray             :       HArray1OfByte from TColStd;
    MyMarkWidth             :       Integer from Standard;
    MyMarkHeight            :       Integer from Standard;

    friends
    
        Remove from class Structure from Graphic3d
            ( me : mutable; AGroup : Group from Graphic3d )
    
    end Group;
Commit	Line	Data
b311480e	1	-- Created on: 1991-09-06
	2	-- Created by: NW,JPB,CAL
	3	-- Copyright (c) 1991-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	5	--
	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
	21	-- 27/09/97 ; PCT : add manual control of textures
	22	-- 11/97 ; CAL : ajout polyline par 2 points
	23	-- 16/06/2000 : ATS: Study G005 - Group store presentations of it's objects in field
	24	-- MyListOfPArray to avoid deletion of handle-manipulating
	25	-- primitives.
	26	class Group from Graphic3d inherits TShared
7fd59977	27
	28	---Version:
	29
	30	---Purpose: This class allows the definition of groups
	31	-- of primitives inside of graphic objects (presentations).
	32	-- A group contains the primitives and attributes
	33	-- for which the range is limited to this group.
	34	-- The primitives of a group can be globally suppressed.
	35	--
	36	-- There are two main group usage models:
	37	--
	38	-- 1) Non-modifiable, or unbounded, group ('black box').
	39	-- Developers can repeat a sequence of
	40	-- SetPrimitivesAspect() with AddPrimitiveArray() methods arbitrary number of times
	41	-- to define arbitrary number of primitive "blocks" each having individual apect values.
	42	-- Any modification of such a group is forbidden, as aspects and primitives are mixed
	43	-- in memory without any high-level logical structure, and any modification is very likely to result
	44	-- in corruption of the group internal data.
	45	-- It is necessary to recreate such a group as a whole when some attribute should be changed.
	46	-- (for example, in terms of AIS it is necessary to re-Compute() the whole presentation each time).
	47	-- 2) Bounded group. Developers should specify the necessary group aspects with help of
	48	-- SetGroupPrimitivesAspect() and then add primitives to the group.
	49	-- Such a group have simplified organization in memory (a single block of attributes
	50	-- followed by a block of primitives) and therefore it can be modified, if it is necessary to
	51	-- change parameters of some aspect that has already been set, using methods:
	52	-- IsGroupPrimitivesAspectSet() to detect which aspect was set for primitives;
	53	-- GroupPrimitivesAspect() to read current aspect values
	54	-- and SetGroupPrimitivesAspect() to set new values.
	55	--
	56	-- Developers are strongly recommended to take all the above into account when filling Graphic3d_Group
	57	-- with aspects and primitives and choose the group usage model beforehand out of application needs.
	58
	59	---Warning:
	60	---References:
	61
	62	uses
	63
	64	Array1OfInteger from TColStd,
	65	Array1OfReal from TColStd,
	66	HArray1OfByte from TColStd,
	67
	68	ExtendedString from TCollection,
	69
	70	PlaneAngle from Quantity,
	71
	72	Array1OfEdge from Aspect,
	73	Edge from Aspect,
	74
	75	GroupAspect from Graphic3d,
	76	AspectLine3d from Graphic3d,
	77	AspectMarker3d from Graphic3d,
	78	AspectText3d from Graphic3d,
	79	AspectFillArea3d from Graphic3d,
	80	HorizontalTextAlignment from Graphic3d,
	81	CBitFields4 from Graphic3d,
	82	CGroup from Graphic3d,
	83	GraphicDriver from Graphic3d,
	84	Structure from Graphic3d,
	85	TextPath from Graphic3d,
7fd59977	86	Vector from Graphic3d,
	87	Array1OfVertex from Graphic3d,
	88	Array2OfVertex from Graphic3d,
	89	Vertex from Graphic3d,
7fd59977	90	VerticalTextAlignment from Graphic3d,
7fd59977	91	ArrayOfPrimitives from Graphic3d,
7fd59977	92	ListOfPArray from Graphic3d,
7fd59977	93	TransModeFlags from Graphic3d,
	94	CBounds from Graphic3d
	95
	96	raises
	97
	98	GroupDefinitionError from Graphic3d,
	99	PickIdDefinitionError from Graphic3d,
	100	OutOfRange from Standard
	101
	102	is
	103	Create ( AStructure : Structure from Graphic3d )
	104	returns mutable Group from Graphic3d;
	105	---Level: Public
	106	---Purpose: Creates a group in the structure <AStructure>.
	107
	108	---------------------------------------------------
	109	-- Category: Methods to modify the class definition
	110	---------------------------------------------------
	111
6c8126b5 A	112	Clear ( me : mutable;
6c8126b5 A	113	theUpdateStructureMgr : Boolean from Standard = Standard_True )
7fd59977	114	is static;
	115	---Level: Public
	116	---Purpose: Supress all primitives and attributes of <me>.
6c8126b5 A	117	-- To clear group without update in Graphic3d_StructureManager
	118	-- pass Standard_False as <theUpdateStructureMgr>. This
	119	-- used on context and viewer destruction, when the pointer
	120	-- to structure manager in Graphic3d_Structure could be
	121	-- already released (pointers are used here to avoid handle
	122	-- cross-reference);
7fd59977	123	---Category: Methods to modify the class definition
	124
	125	Destroy ( me : mutable )
	126	is static;
	127	---Level: Public
	128	---Purpose: Supress the group <me> in the structure.
	129	---Category: Methods to modify the class definition
	130	---C++: alias ~
	131
	132	Remove ( me : mutable )
	133	is static;
	134	---Level: Public
	135	---Purpose: Supress the group <me> in the structure.
	136	-- Warning: No more graphic operations in <me> after this call.
	137	---Category: Methods to modify the class definition
	138
	139	--SetTransformPersistence( me : mutable;
	140	-- AFlag : TransModeFlags from Graphic3d )
	141	---Level: Public
	142	---Purpose: Modifies the current modelling transform persistence (pan, zoom or rotate)
	143	--is static;
	144
	145	--TransformPersistence( me )
	146	-- returns TransModeFlags from Graphic3d
	147	---Level: Public
	148	---Purpose: Get the current modelling transform persistence (pan, zoom or rotate)
	149	--is static;
	150
	151	SetGroupPrimitivesAspect ( me : mutable )
	152	is static;
	153	---Level: Public
	154	---Purpose: Removes the context for all the line primitives
	155	-- of the group.
	156	---Category: Methods to modify the class definition
	157
	158	SetGroupPrimitivesAspect ( me : mutable;
	159	CTX : AspectLine3d from Graphic3d )
	160	is static;
	161	---Level: Public
	162	---Purpose: Modifies the context for all the line primitives
	163	-- of the group.
	164	---Category: Methods to modify the class definition
	165
	166	SetGroupPrimitivesAspect ( me : mutable;
	167	CTX : AspectFillArea3d from Graphic3d )
	168	is static;
	169	---Level: Public
	170	---Purpose: Modifies the context for all the face primitives
	171	-- of the group.
	172	---Category: Methods to modify the class definition
	173
	174	SetGroupPrimitivesAspect ( me : mutable;
	175	CTX : AspectText3d from Graphic3d )
	176	is static;
	177	---Level: Public
	178	---Purpose: Modifies the context for all the text primitives
	179	-- of the group.
	180	---Category: Methods to modify the class definition
	181
	182	SetGroupPrimitivesAspect ( me : mutable;
	183	CTX : AspectMarker3d from Graphic3d )
	184	is static;
	185	---Level: Public
	186	---Purpose: Modifies the context for all the marker primitives
187	-- of the group.
188	---Category: Methods to modify the class definition
189
190	SetPrimitivesAspect ( me : mutable;
191	CTX : AspectLine3d from Graphic3d )
192	is static;
193	---Level: Public
194	---Purpose: Modifies the current context of the group to give
195	-- another aspect for all the line primitives created
196	-- after this call in the group.
197	---Category: Methods to modify the class definition
198
199	SetPrimitivesAspect ( me : mutable;
200	CTX : AspectFillArea3d from Graphic3d )
201	is static;
202	---Level: Public
203	---Purpose: Modifies the current context of the group to give
204	-- another aspect for all the face primitives created
205	-- after this call in the group.
206	---Category: Methods to modify the class definition
207
208	SetPrimitivesAspect ( me : mutable;
209	CTX : AspectText3d from Graphic3d )
210	is static;
211	---Level: Public
212	---Purpose: Modifies the current context of the group to give
213	-- another aspect for all the text primitives created
214	-- after this call in the group.
215	---Category: Methods to modify the class definition
216
217	SetPrimitivesAspect ( me : mutable;
218	CTX : AspectMarker3d from Graphic3d )
219	is static;
220	---Level: Public
221	---Purpose: Modifies the current context of the group to give
222	-- another aspect for all the marker primitives created
223	-- after this call in the group.
224	---Category: Methods to modify the class definition
225
226	SetMinMaxValues ( me : mutable;
227	XMin, YMin, ZMin : Real from Standard;
228	XMax, YMax, ZMax : Real from Standard )
229	is static;
230	---Level: Public
231	---Purpose: Sets the coordinates of the boundary box of the
232	-- group <me>.
233	---Category: Methods to modify the class definition
a577aaab	234
7fd59977	235	-----------------------------------
	236	-- Category: Methods to create Text
	237	-----------------------------------
	238
	239	--------------------------------------------
	240	-- Summary of Texts --
	241	-- --
	242	-- Text has geometric and nongeometric --
	243	-- attributes. --
	244	-- --
	245	-- The geometric text attributes are : --
	246	-- --
	247	-- Character Height. --
	248	-- Character Up Vector. --
	249	-- Text Path. --
	250	-- Text Alignment Horizontal. --
	251	-- Text Alignment Vertical. --
	252	-- --
	253	-- The nongeometric text attributes are : --
	254	-- --
	255	-- Text Font. --
	256	-- Character Spacing. --
	257	-- Character Expansion Factor. --
	258	-- Text Color. --
	259	--------------------------------------------
	260
	261	Text ( me : mutable;
	262	AText : CString from Standard;
	263	APoint : Vertex from Graphic3d;
	264	AHeight : Real from Standard;
	265	AAngle : PlaneAngle from Quantity;
	266	ATp : TextPath from Graphic3d;
	267	AHta : HorizontalTextAlignment from Graphic3d;
	268	AVta : VerticalTextAlignment from Graphic3d;
	269	EvalMinMax : Boolean from Standard = Standard_True )
	270	is static;
	271	---Level: Public
	272	---Purpose: Creates the string <AText> at position <APoint>.
	273	-- The 3D point of attachment is projected. The text is
	274	-- written in the plane of projection.
	275	-- The attributes are given with respect to the plane of
	276	-- projection.
	277	-- AHeight : Height of text.
	278	-- (Relative to the Normalized Projection
	279	-- Coordinates (NPC) Space).
	280	-- AAngle : Orientation of the text
	281	-- (with respect to the horizontal).
	282	---Category: Methods to create Text
	283
	284	Text ( me : mutable;
	285	AText : CString from Standard;
	286	APoint : Vertex from Graphic3d;
	287	AHeight : Real from Standard;
	288	EvalMinMax : Boolean from Standard = Standard_True )
	289	is static;
	290	---Level: Public
	291	---Purpose: Creates the string <AText> at position <APoint>.
	292	-- The 3D point of attachment is projected. The text is
	293	-- written in the plane of projection.
	294	-- The attributes are given with respect to the plane of
	295	-- projection.
	296	-- AHeight : Height of text.
	297	-- (Relative to the Normalized Projection
	298	-- Coordinates (NPC) Space).
299	-- The other attributes have the following default values:
300	-- AAngle : PI / 2.
301	-- ATp : TP_RIGHT
302	-- AHta : HTA_LEFT
303	-- AVta : VTA_BOTTOM
304	---Category: Methods to create Text
305
306	Text ( me : mutable;
307	AText : ExtendedString from TCollection;
308	APoint : Vertex from Graphic3d;
309	AHeight : Real from Standard;
310	AAngle : PlaneAngle from Quantity;
311	ATp : TextPath from Graphic3d;
312	AHta : HorizontalTextAlignment from Graphic3d;
313	AVta : VerticalTextAlignment from Graphic3d;
314	EvalMinMax : Boolean from Standard = Standard_True )
315	is static;
316	---Level: Internal
317	---Purpose: Creates the string <AText> at position <APoint>.
318	-- The 3D point of attachment is projected. The text is
319	-- written in the plane of projection.
320	-- The attributes are given with respect to the plane of
321	-- projection.
322	-- AHeight : Height of text.
323	-- (Relative to the Normalized Projection
324	-- Coordinates (NPC) Space).
325	-- AAngle : Orientation of the text
326	-- (with respect to the horizontal).
327	---Category: Methods to create Text
328
329	Text ( me : mutable;
330	AText : ExtendedString from TCollection;
331	APoint : Vertex from Graphic3d;
332	AHeight : Real from Standard;
333	EvalMinMax : Boolean from Standard = Standard_True )
334	is static;
335	---Level: Internal
336	---Purpose: Creates the string <AText> at position <APoint>.
337	-- The 3D point of attachment is projected. The text is
338	-- written in the plane of projection.
339	-- The attributes are given with respect to the plane of
340	-- projection.
341	-- AHeight : Height of text.
342	-- (Relative to the Normalized Projection
343	-- Coordinates (NPC) Space).
344	-- The other attributes have the following default values:
345	-- AAngle : PI / 2.
346	-- ATp : TP_RIGHT
347	-- AHta : HTA_LEFT
348	-- AVta : VTA_BOTTOM
349	---Category: Methods to create Text
350
351	---------------------------------------
352	---Category: Methods to create Triangle
353	---------------------------------------
2bd4c032	354
7fd59977	355	AddPrimitiveArray( me : mutable;
	356	elem : ArrayOfPrimitives from Graphic3d;
	357	EvalMinMax: Boolean from Standard = Standard_True );
	358	---Level: Public
	359	---Purpose: Adds an array of primitives for display
	360
b311480e	361	UserDraw ( me : mutable;
	362	AnObject : Address from Standard;
	363	EvalMinMax : Boolean from Standard = Standard_True;
	364	ContainsFacet: Boolean from Standard = Standard_False
	365	)
	366	---Level: Public
	367	---Purpose: Creates an UserDraw primitive
	368	-- Category: Methods to create UserDraw
	369	-- Warning: Raises GroupDefinitionError if ...
	370	raises GroupDefinitionError from Graphic3d is static;
7fd59977	371
	372	----------------------------
	373	-- Category: Inquire methods
	374	----------------------------
	375
7fd59977	376	IsGroupPrimitivesAspectSet ( me;
	377	theAspect : GroupAspect from Graphic3d )
	378	returns Boolean from Standard
	379	is static;
	380	---Level: Public
	381	---Purpose: Returns TRUE if aspect is set for the group.
	382	---Category: Inquire methods
	383
	384	GroupPrimitivesAspect ( me;
	385	CTXL : AspectLine3d from Graphic3d;
	386	CTXT : AspectText3d from Graphic3d;
	387	CTXM : AspectMarker3d from Graphic3d;
	388	CTXF : AspectFillArea3d from Graphic3d )
	389	is static;
	390	---Level: Public
	391	---Purpose: Returns the context of all the primitives of the group.
	392	---Category: Inquire methods
	393
	394	PrimitivesAspect ( me;
	395	CTXL : AspectLine3d from Graphic3d;
	396	CTXT : AspectText3d from Graphic3d;
	397	CTXM : AspectMarker3d from Graphic3d;
	398	CTXF : AspectFillArea3d from Graphic3d )
	399	is static;
	400	---Level: Public
	401	---Purpose: Returns the last inserted context in the group <me>
	402	-- foreach kind of primitives.
	403	---Category: Inquire methods
	404
	405	ContainsFacet ( me )
	406	returns Boolean from Standard
	407	is static;
	408	---Level: Internal
	409	---Purpose: Returns Standard_True if the group <me> contains
	410	-- Polygons, Triangles or Quadrangles.
	411	---Category: Inquire methods
	412
	413	IsDeleted ( me )
	414	returns Boolean from Standard
	415	is static;
	416	---Level: Public
	417	---Purpose: Returns Standard_True if the group <me> is deleted.
	418	-- <me> is deleted after the call Remove (me) or the
	419	-- associated structure is deleted.
	420	---Category: Inquire methods
	421
	422	IsEmpty ( me )
	423	returns Boolean from Standard
	424	is static;
	425	---Level: Public
	426	---Purpose: Returns Standard_True if the group <me> is empty.
	427	---Warning: A group is empty if the MinMaxValues method returns :
	428	-- XMin = YMin = ZMin = RealFirst ().
	429	-- XMax = YMax = ZMax = RealLast ().
	430	---Category: Inquire methods
	431
	432	MinMaxValues ( me;
	433	XMin, YMin, ZMin : out Real from Standard;
	434	XMax, YMax, ZMax : out Real from Standard )
	435	is static;
	436	---Level: Public
	437	---Purpose: Returns the coordinates of the boundary box of the
	438	-- group <me>.
	439	---Warning: If the group <me> is empty then :
440	-- XMin = YMin = ZMin = RealFirst ().
441	-- XMax = YMax = ZMax = RealLast ().
442	---Category: Inquire methods
443
444	Structure ( me )
445	returns mutable Structure from Graphic3d
446	is static;
447	---Level: Public
448	---Purpose: Returns the structure containing the group <me>.
449	---Category: Inquire methods
450
451	----------------------------
452	-- Category: Private methods
453	----------------------------
8ca7beb8	454
7fd59977	455	MinMaxCoord ( me;
	456	XMin, YMin, ZMin : out Real from Standard;
	457	XMax, YMax, ZMax : out Real from Standard )
	458	is static private;
	459	---Level: Internal
	460	---Purpose: Returns the extreme coordinates found in the group.
	461	---Warning: If the group <me> is empty then :
	462	-- XMin = YMin = ZMin = RealFirst ().
	463	-- XMax = YMax = ZMax = RealLast ().
	464	---Category: Private methods
	465
	466	Update ( me )
	467	is static private;
	468	---Level: Internal
	469	---Purpose: Calls the Update method of the StructureManager which
	470	-- contains the associated Structure of the Group <me>.
	471	---Category: Private methods
	472
7fd59977	473	fields
	474
	475	--
	476	-- Class : Graphic3d_Group
	477	--
	478	-- Purpose : Declaration of variables specific to groups
	479	-- of primitives.
	480	--
	481	-- Reminder : A group is defined in a structure
	482	-- It acts as the smallest editable entity.
	483
	484	-- the associated C structure
	485	MyCGroup : CGroup from Graphic3d;
	486
	487	-- the graphic driver used
	488	MyGraphicDriver : GraphicDriver from Graphic3d;
	489
	490	-- the state of the different contexts for primitives
	491	MyCBitFields : CBitFields4 from Graphic3d;
	492
	493	-- the structure contains the group
	494	MyPtrStructure : Address from Standard;
	495
	496	-- the min-max
	497	MyBounds : CBounds from Graphic3d;
	498
	499	MyListOfPArray : ListOfPArray from Graphic3d;
7fd59977	500
	501	MyMarkArray : HArray1OfByte from TColStd;
	502	MyMarkWidth : Integer from Standard;
	503	MyMarkHeight : Integer from Standard;
	504
	505	friends
	506
	507	Remove from class Structure from Graphic3d
	508	( me : mutable; AGroup : Group from Graphic3d )
	509
	510	end Group;