[occt.git] / src / MeshVS / MeshVS_Mesh.cdl

-- File     : MeshVS_Mesh.cdl
-- Created  : 10 October 2003
-- Author   : Alexander SOLOVYOV
---Copyright: Open CASCADE 2003


class Mesh from MeshVS inherits InteractiveObject from AIS

	---Purpose: the main class provides interface to create mesh presentation as a whole

uses
  PackedMapOfInteger from TColStd, 
  HPackedMapOfInteger from TColStd,

  InteractiveObject from AIS,

  PresentationManager3d from PrsMgr,

  Presentation from Prs3d,

  NameOfColor from Quantity,

  Selection       from SelectMgr,
  EntityOwner     from SelectMgr,
  SequenceOfOwner from SelectMgr,

  Boolean from Standard,
  CString from Standard,

  PrsBuilder                from MeshVS,
  Drawer                    from MeshVS,
  DataMapOfIntegerOwner     from MeshVS,
  DataSource                from MeshVS,
  SequenceOfPrsBuilder      from MeshVS,
  MeshSelectionMethod       from MeshVS

is

  Create ( theIsAllowOverlapped : Boolean = Standard_False ) returns mutable Mesh;
	---Purpose: Constructor.
        -- theIsAllowOverlapped is Standard_True, if it is allowed to draw edges overlapped with beams
        --   Its value is stored in drawer

  Destroy( me: mutable ) is virtual;
    ---C++: alias ~

  Compute ( me : mutable;
            PM : PresentationManager3d from PrsMgr;
            Prs : Presentation from Prs3d;
            DisplayMode : Integer  ) is redefined;
	---Purpose: Computes presentation using builders added to sequence. Each builder computes
        -- own part of mesh presentation according to its type.

  ComputeSelection ( me : mutable;
                     Sel        : Selection from SelectMgr;
                     SelectMode : Integer ) is redefined;
	---Purpose: Computes selection according to SelectMode

  HilightSelected  ( me : mutable;
                     PM     : PresentationManager3d from PrsMgr;
                     Owners : SequenceOfOwner from SelectMgr ) is redefined;
	---Purpose: Draw selected owners presentation

  HilightOwnerWithColor ( me : mutable;
                          PM : PresentationManager3d from PrsMgr;
                          Color : NameOfColor from Quantity;
                          Owner : EntityOwner from SelectMgr ) is redefined;
	---Purpose: Draw hilighted owner presentation

  ClearSelected         ( me : mutable ) is redefined;
  	---Purpose: Clears internal selection presentation

  GetBuildersCount  ( me ) returns Integer;
	---Purpose: How many builders there are in sequence

  GetBuilder        ( me; Index : Integer )  returns PrsBuilder from MeshVS;
	---Purpose: Returns builder by its index in sequence

  GetBuilderById    ( me; Id    : Integer )  returns PrsBuilder from MeshVS;
	---Purpose: Returns builder by its ID

  GetFreeId         ( me ) returns Integer;
	---Purpose: Returns the smallest positive ID, not occupied by any builder.
        -- This method using when builder is created with ID = -1

  AddBuilder        ( me : mutable;
                      Builder          : PrsBuilder from MeshVS;
                      TreatAsHilighter : Boolean = Standard_False );
	---Purpose: Adds builder to tale of sequence.
        -- PrsBuilder is builder to be added
        -- If TreatAsHilighter is true, MeshVS_Mesh will use this builder to create
        -- presentation of hilighted and selected owners.
        --   Only one builder can be hilighter, so that if you call this method with
        --   TreatAsHilighter = Standard_True some times, only last builder will be hilighter
        --   WARNING: As minimum one builder must be added as hilighter, otherwise selection cannot be computed

  SetHilighter      ( me : mutable; Builder    : PrsBuilder from MeshVS );
	---Purpose: Changes hilighter ( see above )

  SetHilighter      ( me : mutable; Index      : Integer ) returns Boolean;
	---Purpose: Sets builder with sequence index "Index" as hilighter

  SetHilighterById  ( me : mutable; Id         : Integer ) returns Boolean;
	---Purpose: Sets builder with identificator "Id" as hilighter

  GetHilighter      ( me ) returns PrsBuilder from MeshVS;
	---Purpose: Returns hilighter

  RemoveBuilder     ( me : mutable; Index      : Integer );
	---Purpose: Removes builder from sequence. If it is hilighter, hilighter will be NULL
        -- ( Don't remember to set it to other after!!! )

  RemoveBuilderById ( me : mutable; Id         : Integer );
	---Purpose: Removes builder with identificator Id

  FindBuilder       ( me; TypeString : CString )  returns PrsBuilder from MeshVS;
	---Purpose: Finds builder by its type the string represents

  GetOwnerMaps  ( me : mutable; IsElement : Boolean ) returns DataMapOfIntegerOwner from MeshVS;
	---C++: return const &
	---Purpose: Returns map of owners.

  GetDataSource  ( me ) returns DataSource from MeshVS;
	---Purpose: Returns default builders' data source

  SetDataSource  ( me : mutable; aDataSource : DataSource from MeshVS );
	---Purpose: Sets default builders' data source

  GetDrawer  ( me ) returns Drawer from MeshVS;
	---Purpose: Returns default builders' drawer

  SetDrawer  ( me: mutable; aDrawer : Drawer from MeshVS );
	---Purpose: Sets default builders' drawer

  IsHiddenElem ( me; ID: Integer ) returns Boolean;
	---Purpose: Returns True if specified element is hidden
	--          By default no elements are hidden

  IsHiddenNode ( me; ID: Integer ) returns Boolean;
	---Purpose: Returns True if specified node is hidden.
	--          By default all nodes are hidden

  IsSelectableElem ( me; ID: Integer ) returns Boolean;
	---Purpose: Returns True if specified element is not hidden

  IsSelectableNode ( me; ID: Integer ) returns Boolean;
	---Purpose: Returns True if specified node is specified as selectable.

  GetHiddenNodes ( me )
    returns HPackedMapOfInteger from TColStd;
	---C++: return const &
	---Purpose: Returns map of hidden nodes (may be null handle)

  SetHiddenNodes ( me: mutable; Ids : HPackedMapOfInteger from TColStd );
	---Purpose: Sets map of hidden nodes, which shall not be displayed individually.
        --          If nodes shared by some elements shall not be drawn, 
        --          they should be included into that map

  GetHiddenElems ( me )
    returns HPackedMapOfInteger from TColStd;
	---C++: return const &
	---Purpose: Returns map of hidden elements (may be null handle)

  SetHiddenElems ( me: mutable; Ids : HPackedMapOfInteger from TColStd );
	---Purpose: Sets map of hidden elements

  GetSelectableNodes ( me )
    returns HPackedMapOfInteger from TColStd;
	---C++: return const &
	---Purpose: Returns map of selectable elements (may be null handle)

  SetSelectableNodes ( me: mutable; Ids : HPackedMapOfInteger from TColStd );
	---Purpose: Sets map of selectable nodes.

  UpdateSelectableNodes ( me: mutable );
        ---Purpose: Automatically computes selectable nodes; the node is considered 
        --          as being selectable if it is either not hidden, or is hidden
        --          but referred by at least one non-hidden element.
	--          Thus all nodes that are visible (either individually, or as ends or
	--          corners of elements) are selectable by default.

  GetMeshSelMethod( me ) returns MeshSelectionMethod from MeshVS;
	---Purpose: Returns set mesh selection method (see MeshVS.cdl)

  SetMeshSelMethod( me: mutable; M : MeshSelectionMethod from MeshVS );
	---Purpose: Sets mesh selection method (see MeshVS.cdl)

  IsWholeMeshOwner( me; theOwner: EntityOwner from SelectMgr)
        returns Boolean from Standard
        is virtual;
        ---Purpose: Returns True if the given owner represents a whole mesh.

fields
  myBuilders              : SequenceOfPrsBuilder from MeshVS;
  myHilighter             : PrsBuilder from MeshVS;

  myHiddenElements        : HPackedMapOfInteger from TColStd;
  myHiddenNodes           : HPackedMapOfInteger from TColStd;
  mySelectableNodes       : HPackedMapOfInteger from TColStd;

  myNodeOwners            : DataMapOfIntegerOwner from MeshVS is protected;
  myElementOwners         : DataMapOfIntegerOwner from MeshVS is protected;
  my0DOwners              : DataMapOfIntegerOwner from MeshVS is protected;
  myLinkOwners            : DataMapOfIntegerOwner from MeshVS is protected;
  myFaceOwners            : DataMapOfIntegerOwner from MeshVS is protected;
  myVolumeOwners          : DataMapOfIntegerOwner from MeshVS is protected; 
  myGroupOwners           : DataMapOfIntegerOwner from MeshVS is protected;
  myMeshOwners            : DataMapOfIntegerOwner from MeshVS is protected;

  myDataSource            : DataSource from MeshVS;
  myCurrentDrawer         : Drawer from MeshVS is protected;
  mySelectionDrawer       : Drawer from MeshVS is protected;
  myHilightDrawer         : Drawer from MeshVS is protected;
--  mySelectionPrs          : Presentation from Prs3d is protected;
--  myHilightPrs            : Presentation from Prs3d is protected;

  myWholeMeshOwner        : EntityOwner from SelectMgr  is  protected;
  mySelectionMethod       : MeshSelectionMethod from MeshVS;

friends
  class PrsBuilder from MeshVS

end Mesh;
Commit	Line	Data
7fd59977	1	-- File : MeshVS_Mesh.cdl
	2	-- Created : 10 October 2003
	3	-- Author : Alexander SOLOVYOV
	4	---Copyright: Open CASCADE 2003
	5
	6
	7	class Mesh from MeshVS inherits InteractiveObject from AIS
	8
	9	---Purpose: the main class provides interface to create mesh presentation as a whole
	10
	11	uses
	12	PackedMapOfInteger from TColStd,
	13	HPackedMapOfInteger from TColStd,
	14
	15	InteractiveObject from AIS,
	16
	17	PresentationManager3d from PrsMgr,
	18
	19	Presentation from Prs3d,
	20
	21	NameOfColor from Quantity,
	22
	23	Selection from SelectMgr,
	24	EntityOwner from SelectMgr,
	25	SequenceOfOwner from SelectMgr,
	26
	27	Boolean from Standard,
	28	CString from Standard,
	29
	30	PrsBuilder from MeshVS,
	31	Drawer from MeshVS,
	32	DataMapOfIntegerOwner from MeshVS,
	33	DataSource from MeshVS,
	34	SequenceOfPrsBuilder from MeshVS,
	35	MeshSelectionMethod from MeshVS
	36
	37	is
	38
	39	Create ( theIsAllowOverlapped : Boolean = Standard_False ) returns mutable Mesh;
	40	---Purpose: Constructor.
	41	-- theIsAllowOverlapped is Standard_True, if it is allowed to draw edges overlapped with beams
	42	-- Its value is stored in drawer
	43
	44	Destroy( me: mutable ) is virtual;
	45	---C++: alias ~
	46
	47	Compute ( me : mutable;
	48	PM : PresentationManager3d from PrsMgr;
	49	Prs : Presentation from Prs3d;
	50	DisplayMode : Integer ) is redefined;
	51	---Purpose: Computes presentation using builders added to sequence. Each builder computes
	52	-- own part of mesh presentation according to its type.
	53
	54	ComputeSelection ( me : mutable;
	55	Sel : Selection from SelectMgr;
	56	SelectMode : Integer ) is redefined;
	57	---Purpose: Computes selection according to SelectMode
	58
	59	HilightSelected ( me : mutable;
	60	PM : PresentationManager3d from PrsMgr;
	61	Owners : SequenceOfOwner from SelectMgr ) is redefined;
	62	---Purpose: Draw selected owners presentation
	63
	64	HilightOwnerWithColor ( me : mutable;
65	PM : PresentationManager3d from PrsMgr;
66	Color : NameOfColor from Quantity;
67	Owner : EntityOwner from SelectMgr ) is redefined;
68	---Purpose: Draw hilighted owner presentation
69
70	ClearSelected ( me : mutable ) is redefined;
71	---Purpose: Clears internal selection presentation
72
73	GetBuildersCount ( me ) returns Integer;
74	---Purpose: How many builders there are in sequence
75
76	GetBuilder ( me; Index : Integer ) returns PrsBuilder from MeshVS;
77	---Purpose: Returns builder by its index in sequence
78
79	GetBuilderById ( me; Id : Integer ) returns PrsBuilder from MeshVS;
80	---Purpose: Returns builder by its ID
81
82	GetFreeId ( me ) returns Integer;
83	---Purpose: Returns the smallest positive ID, not occupied by any builder.
84	-- This method using when builder is created with ID = -1
85
86	AddBuilder ( me : mutable;
87	Builder : PrsBuilder from MeshVS;
88	TreatAsHilighter : Boolean = Standard_False );
89	---Purpose: Adds builder to tale of sequence.
90	-- PrsBuilder is builder to be added
91	-- If TreatAsHilighter is true, MeshVS_Mesh will use this builder to create
92	-- presentation of hilighted and selected owners.
93	-- Only one builder can be hilighter, so that if you call this method with
94	-- TreatAsHilighter = Standard_True some times, only last builder will be hilighter
95	-- WARNING: As minimum one builder must be added as hilighter, otherwise selection cannot be computed
96
97	SetHilighter ( me : mutable; Builder : PrsBuilder from MeshVS );
98	---Purpose: Changes hilighter ( see above )
99
100	SetHilighter ( me : mutable; Index : Integer ) returns Boolean;
101	---Purpose: Sets builder with sequence index "Index" as hilighter
102
103	SetHilighterById ( me : mutable; Id : Integer ) returns Boolean;
104	---Purpose: Sets builder with identificator "Id" as hilighter
105
106	GetHilighter ( me ) returns PrsBuilder from MeshVS;
107	---Purpose: Returns hilighter
108
109	RemoveBuilder ( me : mutable; Index : Integer );
110	---Purpose: Removes builder from sequence. If it is hilighter, hilighter will be NULL
111	-- ( Don't remember to set it to other after!!! )
112
113	RemoveBuilderById ( me : mutable; Id : Integer );
114	---Purpose: Removes builder with identificator Id
115
116	FindBuilder ( me; TypeString : CString ) returns PrsBuilder from MeshVS;
117	---Purpose: Finds builder by its type the string represents
118
119	GetOwnerMaps ( me : mutable; IsElement : Boolean ) returns DataMapOfIntegerOwner from MeshVS;
120	---C++: return const &
121	---Purpose: Returns map of owners.
122
123	GetDataSource ( me ) returns DataSource from MeshVS;
124	---Purpose: Returns default builders' data source
125
126	SetDataSource ( me : mutable; aDataSource : DataSource from MeshVS );
127	---Purpose: Sets default builders' data source
128
129	GetDrawer ( me ) returns Drawer from MeshVS;
130	---Purpose: Returns default builders' drawer
131
132	SetDrawer ( me: mutable; aDrawer : Drawer from MeshVS );
133	---Purpose: Sets default builders' drawer
134
135	IsHiddenElem ( me; ID: Integer ) returns Boolean;
136	---Purpose: Returns True if specified element is hidden
137	-- By default no elements are hidden
138
139	IsHiddenNode ( me; ID: Integer ) returns Boolean;
140	---Purpose: Returns True if specified node is hidden.
141	-- By default all nodes are hidden
142
143	IsSelectableElem ( me; ID: Integer ) returns Boolean;
144	---Purpose: Returns True if specified element is not hidden
145
146	IsSelectableNode ( me; ID: Integer ) returns Boolean;
147	---Purpose: Returns True if specified node is specified as selectable.
148
149	GetHiddenNodes ( me )
150	returns HPackedMapOfInteger from TColStd;
151	---C++: return const &
152	---Purpose: Returns map of hidden nodes (may be null handle)
153
154	SetHiddenNodes ( me: mutable; Ids : HPackedMapOfInteger from TColStd );
155	---Purpose: Sets map of hidden nodes, which shall not be displayed individually.
156	-- If nodes shared by some elements shall not be drawn,
157	-- they should be included into that map
158
159	GetHiddenElems ( me )
160	returns HPackedMapOfInteger from TColStd;
161	---C++: return const &
162	---Purpose: Returns map of hidden elements (may be null handle)
163
164	SetHiddenElems ( me: mutable; Ids : HPackedMapOfInteger from TColStd );
165	---Purpose: Sets map of hidden elements
166
167	GetSelectableNodes ( me )
168	returns HPackedMapOfInteger from TColStd;
169	---C++: return const &
170	---Purpose: Returns map of selectable elements (may be null handle)
171
172	SetSelectableNodes ( me: mutable; Ids : HPackedMapOfInteger from TColStd );
173	---Purpose: Sets map of selectable nodes.
174
175	UpdateSelectableNodes ( me: mutable );
176	---Purpose: Automatically computes selectable nodes; the node is considered
177	-- as being selectable if it is either not hidden, or is hidden
178	-- but referred by at least one non-hidden element.
179	-- Thus all nodes that are visible (either individually, or as ends or
180	-- corners of elements) are selectable by default.
181
182	GetMeshSelMethod( me ) returns MeshSelectionMethod from MeshVS;
183	---Purpose: Returns set mesh selection method (see MeshVS.cdl)
184
185	SetMeshSelMethod( me: mutable; M : MeshSelectionMethod from MeshVS );
186	---Purpose: Sets mesh selection method (see MeshVS.cdl)
187
188	IsWholeMeshOwner( me; theOwner: EntityOwner from SelectMgr)
189	returns Boolean from Standard
190	is virtual;
191	---Purpose: Returns True if the given owner represents a whole mesh.
192
193	fields
194	myBuilders : SequenceOfPrsBuilder from MeshVS;
195	myHilighter : PrsBuilder from MeshVS;
196
197	myHiddenElements : HPackedMapOfInteger from TColStd;
198	myHiddenNodes : HPackedMapOfInteger from TColStd;
199	mySelectableNodes : HPackedMapOfInteger from TColStd;
200
201	myNodeOwners : DataMapOfIntegerOwner from MeshVS is protected;
202	myElementOwners : DataMapOfIntegerOwner from MeshVS is protected;
203	my0DOwners : DataMapOfIntegerOwner from MeshVS is protected;
204	myLinkOwners : DataMapOfIntegerOwner from MeshVS is protected;
205	myFaceOwners : DataMapOfIntegerOwner from MeshVS is protected;
206	myVolumeOwners : DataMapOfIntegerOwner from MeshVS is protected;
207	myGroupOwners : DataMapOfIntegerOwner from MeshVS is protected;
208	myMeshOwners : DataMapOfIntegerOwner from MeshVS is protected;
209
210	myDataSource : DataSource from MeshVS;
211	myCurrentDrawer : Drawer from MeshVS is protected;
212	mySelectionDrawer : Drawer from MeshVS is protected;
213	myHilightDrawer : Drawer from MeshVS is protected;
214	-- mySelectionPrs : Presentation from Prs3d is protected;
215	-- myHilightPrs : Presentation from Prs3d is protected;
216
217	myWholeMeshOwner : EntityOwner from SelectMgr is protected;
218	mySelectionMethod : MeshSelectionMethod from MeshVS;
219
220	friends
221	class PrsBuilder from MeshVS
222
223	end Mesh;