1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-09 18:50:54 +03:00
occt/src/Visual3d/Visual3d_ContextPick.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast
Wrong license statements corrected in several files.
Copyright and license statements added in XSD and GLSL files.
Copyright year updated in some files.
Obsolete documentation files removed from DrawResources.
2014-02-20 16:15:17 +04:00

149 lines
4.1 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

-- Created on: 1991-11-25
-- Created by: NW,JPB,CAL
-- Copyright (c) 1991-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 ContextPick from Visual3d
---Version:
---Purpose: This class allows the creation and update of
-- a pick context for one view of the viewer.
-- A context allows the control of different parameters
-- before the activation of a pick.
--
-- * the pick aperture.
-- * the depth of pick, the number of sub-structures selected.
-- * the order of picking, the possibility to traverse
-- the pick structures starting from the root
-- or the leaves.
---Keywords: Pick, Context, Aperture, Depth, Order, Structure
---Warning:
---References:
uses
TypeOfOrder from Visual3d
raises
ContextPickDefinitionError from Visual3d
is
Create
returns ContextPick from Visual3d;
---Level: Public
---Purpose: Creates a context from default values
--
-- Aperture : 4.0
-- Depth : 10
-- Order : TOO_TOPFIRST
Create ( Aperture : Real from Standard;
Depth : Integer from Standard;
Order : TypeOfOrder from Visual3d )
returns ContextPick from Visual3d
---Level: Public
---Purpose: Creates a context with the values defined
-- Warning: Raises ContextPickDefinitionError if <Depth> or
-- <Aperture> is a negative value.
raises ContextPickDefinitionError;
-----------------------------------------------------
-- Category: Methods to modifies the class definition
-----------------------------------------------------
SetAperture ( me : in out;
Aperture : Real from Standard )
---Level: Public
---Purpose: Modifies the size of the pick window.
-- Category: Methods to modifies the class definition
-- Warning: Raises ContextPickDefinitionError if <Aperture> is
-- a negative value.
raises ContextPickDefinitionError is static;
SetDepth ( me : in out;
Depth : Integer from Standard )
---Level: Public
---Purpose: Modifies the pick depth a priori.
-- Category: Methods to modifies the class definition
-- Warning: Raises ContextPickDefinitionError if <Depth> is
-- a negative value.
raises ContextPickDefinitionError is static;
SetOrder ( me : in out;
Order : TypeOfOrder from Visual3d ) is static;
---Level: Public
---Purpose: Modifies the order of picking.
--
-- TypeOfOrder : TOO_TOPFIRST
-- TOO_BOTTOMFIRST
--
---Category: Methods to modifies the class definition
----------------------------
-- Category: Inquire methods
----------------------------
Aperture ( me )
returns Real from Standard is static;
---Level: Public
---Purpose: Returns the size of the pick window <me>.
---Category: Inquire methods
Depth ( me )
returns Integer from Standard is static;
---Level: Public
---Purpose: Returns the effective pick depth of <me>.
---Category: Inquire methods
Order ( me )
returns TypeOfOrder from Visual3d is static;
---Level: Public
---Purpose: Returns the order of picking of <me>.
--
-- TypeOfOrder : TOO_TOPFIRST
-- TOO_BOTTOMFIRST
--
---Category: Inquire methods
--
fields
--
-- Class : Visual3d_ContextPick
--
-- Purpose : Declaration of variables specific to
-- pick contexts
--
-- Reminders : A pick context is defined by:
-- - the pick aperture
-- - the depth demanded
-- - the order of traversing the structure
-- aperture of pick
MyAperture : Real from Standard;
-- depth of pick
MyDepth : Integer from Standard;
-- order of traversing pick structures
MyOrder : TypeOfOrder from Visual3d;
end ContextPick;