src/Graphic3d/Graphic3d_Texture1D.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 deferred class Texture1D from Graphic3d
  22
  23 inherits TextureMap from Graphic3d
  24
  25   ---Purpose: This is an abstract class for managing 1D textures.
  26
  27 uses
  28
  29   TypeOfTexture   from Graphic3d,
  30   NameOfTexture1D from Graphic3d,
  31   AsciiString     from TCollection
  32
  33 raises
  34
  35   OutOfRange from Standard
  36
  37 is
  38
  39   Initialize (theFileName : AsciiString from TCollection;
  40               theType     : TypeOfTexture from Graphic3d);
  41
  42   Initialize (theName : NameOfTexture1D from Graphic3d;
  43               theType : TypeOfTexture   from Graphic3d);
  44
  45   Name (me) returns NameOfTexture1D from Graphic3d;
  46   ---Purpose:
  47   -- Returns the name of the predefined textures or NOT_1D_UNKNOWN
  48   -- when the name is given as a filename.
  49   ---Level: Public
  50
  51   NumberOfTextures (myclass) returns Integer from Standard;
  52   ---Purpose:
  53   -- Returns the number of predefined textures.
  54   ---Level: Public
  55
  56   TextureName (myclass; aRank: Integer from Standard)
  57   returns AsciiString from TCollection
  58   raises OutOfRange from Standard;
  59   ---Purpose:
  60   -- Returns the name of the predefined texture of rank <aRank>
  61   ---Trigger: when <aRank> is < 1 or > NumberOfTextures.
  62   ---Level: Public
  63
  64 fields
  65
  66   myName : NameOfTexture1D from Graphic3d;
  67
  68 end Texture1D;