mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-05 18:16:23 +03:00
ff8178ef85
Mostly duplicated comments were removed and missing ones were moved into dedicated class CDL files. Some more duplicated comments were removed from CDL files. Correction of merge
102 lines
3.2 KiB
Plaintext
102 lines
3.2 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 License 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.
|
|
|
|
class GenericColorMap from Aspect inherits ColorMap from Aspect
|
|
|
|
---Version: 0.0
|
|
|
|
---Level: Public
|
|
---Purpose: This class defines a GenericColorMap object.
|
|
-- Associates an index and a color.
|
|
---Keywords:
|
|
---Warning:
|
|
---References:
|
|
|
|
uses
|
|
Color from Quantity,
|
|
TypeOfColorMap from Aspect,
|
|
ColorMapEntry from Aspect,
|
|
DataMapOfIntegerInteger from TColStd
|
|
|
|
raises
|
|
|
|
BadAccess from Aspect
|
|
|
|
is
|
|
|
|
Create
|
|
returns 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;
|