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 -- Modified :   GG 10/01/2000 IMP
  22 --              Add NumberOfTextures() and TextureName() methods
  23 --              Add Name() method
  24
  25 class  TextureEnv  from  Graphic3d
  26
  27 inherits  TextureRoot  from  Graphic3d
  28
  29
  30     ---Purpose: This class provides environment texture usable only in Visual3d_ContextView
  31
  32 uses
  33     NameOfTextureEnv  from  Graphic3d,
  34     StructureManager  from  Graphic3d
  35
  36 raises
  37     OutOfRange from Standard
  38
  39 is
  40     Create(SM  :  StructureManager  from  Graphic3d;
  41            aFileName  :  CString  from  Standard)
  42         returns  mutable TextureEnv  from  Graphic3d;
  43     ---Purpose: Creates an environment texture from a file
  44
  45     Create(SM   :  StructureManager  from  Graphic3d;
  46            aName:  NameOfTextureEnv  from  Graphic3d)
  47         returns  mutable  TextureEnv  from  Graphic3d;
  48     ---Purpose: Creates an environment texture from a predefined texture name set.
  49
  50     Name(me) returns NameOfTextureEnv from Graphic3d;
  51     ---Purpose:
  52     -- Returns the name of the predefined textures or NOT_ENV_UNKNOWN
  53     -- when the name is given as a filename.
  54     ---Level: Public
  55
  56     NumberOfTextures(myclass) returns Integer from Standard;
  57     ---Purpose:
  58     -- Returns the number of predefined textures.
  59     ---Level: Public
  60
  61     TextureName(myclass; aRank: Integer from Standard)
  62         returns CString from Standard
  63         raises OutOfRange from Standard;
  64     ---Purpose:
  65     -- Returns the name of the predefined texture of rank <aRank>
  66     ---Trigger: when <aRank> is < 1 or > NumberOfTextures.
  67     ---Level: Public
  68
  69 fields
  70     myName: NameOfTextureEnv from Graphic3d;
  71
  72 end  TextureEnv;
  73