mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-05-21 10:55:33 +03:00
106 lines
3.5 KiB
Plaintext
Executable File
106 lines
3.5 KiB
Plaintext
Executable File
-- Created on: 1993-03-23
|
|
-- Created by: BBL
|
|
-- Copyright (c) 1993-1999 Matra Datavision
|
|
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
|
|
--
|
|
-- The content of this file is subject to the Open CASCADE Technology Public
|
|
-- License Version 6.5 (the "License"). You may not use the content of this file
|
|
-- except in compliance with the License. Please obtain a copy of the License
|
|
-- at http://www.opencascade.org and read it completely before using this file.
|
|
--
|
|
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
|
|
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
|
|
--
|
|
-- The Original Code and all software distributed under the License is
|
|
-- distributed on an "AS IS" basis, without warranty of any kind, and the
|
|
-- Initial Developer hereby disclaims all such warranties, including without
|
|
-- limitation, any warranties of merchantability, fitness for a particular
|
|
-- purpose or non-infringement. Please see the License for the specific terms
|
|
-- and conditions governing the rights and limitations under the License.
|
|
|
|
|
|
class GenericColorMap from Aspect inherits ColorMap from Aspect
|
|
|
|
---Version: 0.0
|
|
|
|
---Level: Public
|
|
---Purpose: This class defines a GenericColorMap object.
|
|
---Keywords:
|
|
---Warning:
|
|
---References:
|
|
|
|
uses
|
|
Color from Quantity,
|
|
TypeOfColorMap from Aspect,
|
|
ColorMapEntry from Aspect,
|
|
DataMapOfIntegerInteger from TColStd
|
|
|
|
raises
|
|
|
|
BadAccess from Aspect
|
|
|
|
is
|
|
|
|
Create
|
|
returns mutable GenericColorMap from Aspect;
|
|
---Level: Public
|
|
---Purpose: Creates a generic ColorMap .
|
|
|
|
AddEntry (me : mutable; AnEntry : ColorMapEntry from Aspect)
|
|
---Level: Public
|
|
---Purpose: Adds an entry in the color map <me>.
|
|
-- Warning: Raises BadAccess if the ColorMapEntry index is alreadry
|
|
-- defined.
|
|
raises BadAccess from Aspect;
|
|
|
|
AddEntry (me : mutable; aColor : Color from Quantity)
|
|
returns Integer from Standard;
|
|
---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.
|
|
RemoveEntry ( me: mutable;
|
|
AColorMapEntryIndex : Integer from Standard )
|
|
raises BadAccess from Aspect ;
|
|
---Level: Public
|
|
---Purpose: Remove the ColorMapEntry at position index in the ColorMap
|
|
-- Warning: Raises BadAccess if the index is not defined in the
|
|
-- ColorMap.
|
|
|
|
FindColorMapIndex ( me ; AColorMapEntryIndex : Integer from Standard )
|
|
returns Integer from Standard
|
|
raises BadAccess from Aspect ;
|
|
---Level: Public
|
|
---Purpose: Returns the index in the ColorMap of the
|
|
-- ColorMapEntry.Index() equal to <AnEntryIndex>.
|
|
-- Warning: Raises BadAccess if the index is not defined in the
|
|
-- ColorMap.
|
|
|
|
FindEntry ( me ; AColorMapEntryIndex : Integer from Standard )
|
|
returns ColorMapEntry from Aspect
|
|
raises BadAccess from Aspect ;
|
|
---Level: Public
|
|
---Purpose: Returns the ColorMapEntry with ColorMapEntry.Index()
|
|
-- equal to <AnEntryIndex>.
|
|
-- Warning: Raises BadAccess if the index is not defined in the
|
|
-- ColorMap.
|
|
---C++: return const &
|
|
|
|
NearestColorMapIndex( me ; aColor : Color from Quantity )
|
|
returns Integer from Standard ;
|
|
---Level: Public
|
|
---Purpose: Returns the index in the ColorMap of the
|
|
-- nearest matching ColorMapEntry
|
|
|
|
NearestEntry( me ; aColor : Color from Quantity )
|
|
returns ColorMapEntry from Aspect ;
|
|
---Level: Public
|
|
---Purpose: Returns the nearest ColorMapEntry that match aColor .
|
|
---C++: return const &
|
|
|
|
fields
|
|
|
|
myDataMap : DataMapOfIntegerInteger from TColStd is protected;
|
|
|
|
end GenericColorMap;
|