7c318a79780bbec5980e5908217ac1ef1d43eff6
[occt.git] / src / Graphic3d / Graphic3d_TextureEnv.cdl
1 -- Created on: 1997-07-28
2 -- Created by: Pierre CHALAMET
3 -- Copyright (c) 1997-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 class TextureEnv from Graphic3d
22
23 inherits TextureRoot from Graphic3d
24
25   ---Purpose: This class provides environment texture usable only in Visual3d_ContextView
26
27 uses
28
29   NameOfTextureEnv from Graphic3d,
30   AsciiString      from TCollection
31
32 raises
33
34   OutOfRange from Standard
35
36 is
37
38   Create (theFileName : AsciiString from TCollection) returns  mutable TextureEnv from Graphic3d;
39   ---Purpose: Creates an environment texture from a file.
40
41   Create (theName : NameOfTextureEnv from Graphic3d) returns mutable TextureEnv from Graphic3d;
42   ---Purpose: Creates an environment texture from a predefined texture name set.
43
44   Name (me) returns NameOfTextureEnv from Graphic3d;
45   ---Purpose:
46   -- Returns the name of the predefined textures or NOT_ENV_UNKNOWN
47   -- when the name is given as a filename.
48   ---Level: Public
49
50   NumberOfTextures (myclass) returns Integer from Standard;
51   ---Purpose:
52   -- Returns the number of predefined textures.
53   ---Level: Public
54
55   TextureName (myclass; theRank: Integer from Standard)
56   returns AsciiString from TCollection
57   raises OutOfRange from Standard;
58   ---Purpose:
59   -- Returns the name of the predefined texture of rank <aRank>
60   ---Trigger: when <aRank> is < 1 or > NumberOfTextures.
61   ---Level: Public
62
63 fields
64
65   myName : NameOfTextureEnv from Graphic3d;
66
67 end TextureEnv;