Files
OCCT/src/Aspect/Aspect_ColorMap.cdl
bugmster 973c2be1e1 0024428: Implementation of LGPL license
The copying permission statements at the beginning of source files updated to refer to LGPL.
Copyright dates extended till 2014 in advance.
2013-12-17 12:42:41 +04:00

112 lines
3.6 KiB
Plaintext

-- Created on: 1993-03-23
-- Created by: BBL
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and / or modify it
-- under the terms of the GNU Lesser General Public version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
deferred class ColorMap from Aspect inherits TShared from MMgt
---Version: 0.0
---Purpose: This class defines a ColorMap object.
---Keywords:
---Warning:
---References:
uses
Color from Quantity,
TypeOfColorMap from Aspect,
ColorMapEntry from Aspect,
SequenceOfColorMapEntry from Aspect
raises
BadAccess from Aspect
is
Initialize( type : TypeOfColorMap from Aspect );
Type( me )
returns TypeOfColorMap from Aspect is static;
---Level: Public
Size( me ) returns Integer from Standard is static;
---Level: Public
---Purpose: Returns the Allocated colormap Size
Index( me ; aColormapIndex : Integer ) returns Integer from Standard
---Level: Public
---Purpose: Returns the ColorMapEntry.Index of the ColorMap
-- at rank <aColormapIndex> .
raises BadAccess from Aspect is static;
---Trigger: Raises BadAccess if the index less than 1 or
-- greater than Size.
Dump( me ) ;
---Level: Internal
Entry ( me ; AColorMapIndex : Integer from Standard )
returns ColorMapEntry from Aspect
---Level: Public
---Purpose: Return the value of the <Index>th element of
-- the ColorMap
raises BadAccess from Aspect is static;
---Trigger: Raises BadAccess if the index less than 1 or
-- greater than Size.
---C++: return const &
FindColorMapIndex ( me ;
AColorMapEntryIndex : Integer from Standard )
returns Integer from Standard
---Level: Public
---Purpose: Returns the index in the ColorMap of the
-- ColorMapEntry.Index() equal to <AnEntryIndex>.
raises BadAccess from Aspect is deferred ;
---Trigger: Raises BadAccess if the index is not defined in the
-- ColorMap.
FindEntry ( me ; AColorMapEntryIndex : Integer from Standard )
returns ColorMapEntry from Aspect
---Level: Public
---Purpose: Returns the ColorMapEntry with ColorMapEntry.Index()
-- equal to <AnEntryIndex>.
raises BadAccess from Aspect is deferred ;
---Trigger: Raises BadAccess if the index is not defined in the
-- ColorMap.
---C++: return const &
NearestColorMapIndex( me ; aColor : Color from Quantity )
returns Integer from Standard is deferred ;
---Level: Public
---Purpose: Returns the index in the ColorMap of the
-- nearest matching ColorMapEntry
NearestEntry( me ; aColor : Color from Quantity )
returns ColorMapEntry from Aspect is deferred ;
---Level: Public
---Purpose: Returns the nearest ColorMapEntry that match aColor .
---C++: return const &
AddEntry (me : mutable; aColor : Color from Quantity)
returns Integer from Standard is deferred;
---Level: Public
---Purpose: Search an identical color entry in the color map <me>
-- and returns the ColorMapEntry Index if exist.
-- Or add a new entry and returns the computed ColorMapEntry index used.
fields
mytype : TypeOfColorMap from Aspect;
mydata : SequenceOfColorMapEntry from Aspect is protected;
end ColorMap ;