1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-21 10:13:43 +03:00
occt/src/TPrsStd/TPrsStd_AISViewer.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

114 lines
4.0 KiB
Plaintext
Executable File

-- Created on: 1998-09-30
-- Created by: Denis PASCAL
-- Copyright (c) 1998-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 AISViewer from TPrsStd inherits Attribute from TDF
---Purpose: The groundwork to define an interactive viewer attribute.
-- This attribute stores an interactive context at the root label.
-- You can only have one instance of this class per data framework.
uses Attribute from TDF,
Label from TDF,
GUID from Standard,
DataSet from TDF,
RelocationTable from TDF,
InteractiveContext from AIS,
Viewer from V3d,
ExtendedString from TCollection
is
---Purpose: class methods
-- =============
GetID (myclass)
---C++: return const &
returns GUID from Standard;
Has (myclass; acces : Label from TDF)
---Purpose: returns True if there is an AISViewer attribute in
-- <acces> Data Framework.
returns Boolean from Standard;
New (myclass; access : Label from TDF; selector : InteractiveContext from AIS)
---Purpose: create and set an AISViewer at. Raise an exception if
-- Has.
returns AISViewer from TPrsStd;
New (myclass; acces : Label from TDF; viewer : Viewer from V3d)
---Purpose: create and set an AISAttribute at root label. The
-- interactive context is build. Raise an exception if
-- Has.
returns AISViewer from TPrsStd;
Find (myclass; acces : Label from TDF; A : in out AISViewer from TPrsStd)
returns Boolean from Standard;
---Purpose:
-- Finds the viewer attribute at the label access, the
-- root of the data framework. Calling this function can be used to initialize an AIS viewer
Find (myclass; acces : Label from TDF; IC : in out InteractiveContext from AIS)
returns Boolean from Standard;
Find (myclass; acces : Label from TDF; V : in out Viewer from V3d)
returns Boolean from Standard;
Update (myclass; acces : Label from TDF);
---Purpose: AISViewer methods
-- =================
Create
returns mutable AISViewer from TPrsStd;
Update (me);
---Purpose: Updates the viewer at the label access.
-- access is the root of the data framework.
SetInteractiveContext (me : mutable; ctx : InteractiveContext from AIS);
---Purpose: Sets the interactive context ctx for this attribute.
GetInteractiveContext (me)
returns InteractiveContext from AIS;
---Purpose: Returns the interactive context in this attribute.
---Category: TDF_Attribute methods
-- =====================
ID (me)
---C++: return const &
returns GUID from Standard;
Restore(me: mutable; with : Attribute from TDF);
NewEmpty(me)
returns mutable Attribute from TDF;
Paste (me; into : mutable Attribute from TDF;
RT : mutable RelocationTable from TDF);
fields
myInteractiveContext : InteractiveContext from AIS;
end AISViewer;