b311480e |
1 | -- Created on: 1993-01-18 |
2 | -- Created by: Gilles DEBARBOUILLE |
3 | -- Copyright (c) 1993-1999 Matra Datavision |
973c2be1 |
4 | -- Copyright (c) 1999-2014 OPEN CASCADE SAS |
b311480e |
5 | -- |
973c2be1 |
6 | -- This file is part of Open CASCADE Technology software library. |
b311480e |
7 | -- |
d5f74e42 |
8 | -- This library is free software; you can redistribute it and/or modify it under |
9 | -- the terms of the GNU Lesser General Public License version 2.1 as published |
973c2be1 |
10 | -- by the Free Software Foundation, with special exception defined in the file |
11 | -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
12 | -- distribution for complete text of the license and disclaimer of any warranty. |
b311480e |
13 | -- |
973c2be1 |
14 | -- Alternatively, this file may be used under the terms of Open CASCADE |
15 | -- commercial license or contractual agreement. |
7fd59977 |
16 | |
17 | class MaterialsDictionary from Materials |
18 | |
19 | ---Purpose: This class creates a dictionary of materials. |
20 | |
21 | inherits |
22 | |
23 | Transient |
24 | |
25 | uses |
6c3e4c29 |
26 | OStream from Standard, |
7fd59977 |
27 | HAsciiString from TCollection, |
28 | MaterialsSequence from Materials, |
29 | Material from Materials |
30 | |
31 | raises |
32 | |
33 | NoSuchObject from Standard |
34 | |
35 | is |
36 | |
37 | Create returns mutable MaterialsDictionary from Materials; |
38 | ---Level: Internal |
39 | ---Purpose: Returns a MaterialsDictionary object which contains |
40 | -- the sequence of all the materials the user wants to |
41 | -- consider. |
42 | |
43 | Material(me ; amaterial : CString from Standard) returns Material from Materials |
44 | raises NoSuchObject from Standard |
45 | ---Level: Internal |
46 | ---Purpose: Retrieves from the dictionary the object material with |
47 | -- <amaterial> as name. If <amaterial> does not exist in |
48 | -- the dictionary an exeption is raised. |
49 | is static; |
50 | |
51 | ExistMaterial(me ; aName : CString from Standard) returns Boolean from Standard; |
52 | ---Purpose: True if the materialofname aName exists ... |
53 | |
54 | NumberOfMaterials(me) returns Integer from Standard |
55 | ---Level: Internal |
56 | ---Purpose: Returns the number of materials previously stored in |
57 | -- the dictionary. |
58 | is static; |
59 | |
60 | Material(me ; anindex : Integer from Standard) returns Material from Materials |
61 | ---Level: Internal |
62 | ---Purpose: This method used with the previous one, allow the |
63 | -- exploration of all the dictionary. It returns a |
64 | -- Material instance. |
65 | is static; |
66 | |
67 | UpToDate(me) returns Boolean from Standard |
68 | ---Level: Internal |
69 | ---Purpose: Returns true if there has been no modification of the |
70 | -- file Materials.dat since the creation of the dictionary |
71 | -- object, false otherwise. |
72 | is static; |
73 | |
74 | Dump(me ; astream : in out OStream from Standard ) |
75 | ---Level: Internal |
76 | ---Purpose: Useful for debugging. |
77 | is static; |
78 | |
79 | fields |
80 | |
81 | thefilename : HAsciiString from TCollection; |
6c3e4c29 |
82 | thetime : Time from Standard; |
7fd59977 |
83 | thematerialssequence : MaterialsSequence from Materials; |
84 | |
85 | end MaterialsDictionary; |