| 7fd59977 |
1 | -- |
| 2 | -- File: Visual3d_PickPath.cdl |
| 3 | -- Created: Lundi 25 Novembre 1991 |
| 4 | -- Author: NW,JPB,CAL |
| 5 | -- |
| 6 | ---Copyright: MatraDatavision 1991,1992,1993 |
| 7 | -- |
| 8 | |
| 9 | class PickPath from Visual3d |
| 10 | |
| 11 | ---Version: |
| 12 | |
| 13 | ---Purpose: PickPath is a vector ( pick_id, struct_id, elem_num ). |
| 14 | -- It's one of the constituents of a PickDescriptor. |
| 15 | -- There are many PickPaths in a PickDescriptor. |
| 16 | -- Each PickPath describes a structure or a sub-structure. |
| 17 | -- The pick_id is set by SetPickId method from Group. |
| 18 | |
| 19 | ---Keywords: Pick Path, PickId |
| 20 | |
| 21 | ---Warning: |
| 22 | ---References: |
| 23 | |
| 24 | uses |
| 25 | |
| 26 | Structure from Graphic3d |
| 27 | |
| 28 | raises |
| 29 | |
| 30 | PickError from Visual3d |
| 31 | |
| 32 | is |
| 33 | |
| 34 | Create |
| 35 | returns PickPath from Visual3d; |
| 36 | ---Level: Public |
| 37 | ---Purpose: Creates an undefined PickPath. |
| 38 | |
| 39 | Create ( AElemNumber : Integer from Standard; |
| 40 | APickId : Integer from Standard; |
| 41 | AStructure : Structure from Graphic3d) |
| 42 | returns PickPath from Visual3d; |
| 43 | ---Level: Public |
| 44 | ---Purpose: Creates a PickPath : |
| 45 | -- <AElemNumber> : Element number of the structure picked. |
| 46 | -- <APickId> : Pick identifier of the structure picked. |
| 47 | -- <AStructure> : The picked structure. |
| 48 | |
| 49 | --------------------------------------------------- |
| 50 | -- Category: Methods to modify the class definition |
| 51 | --------------------------------------------------- |
| 52 | |
| 53 | SetElementNumber ( me : in out; |
| 54 | AElemNumber : Integer from Standard ) |
| 55 | is static; |
| 56 | ---Level: Public |
| 57 | ---Purpose: Modifies the PickPath <me>. |
| 58 | -- <AElemNumber> : Element number of the structure picked. |
| 59 | ---Category: Methods to modify the class definition |
| 60 | |
| 61 | SetPickIdentifier ( me : in out; |
| 62 | APickId : Integer from Standard ) |
| 63 | is static; |
| 64 | ---Level: Public |
| 65 | ---Purpose: Modifies the PickPath <me>. |
| 66 | -- <APickId> : Pick identifier of the structure picked. |
| 67 | ---Category: Methods to modify the class definition |
| 68 | |
| 69 | SetStructIdentifier ( me : in out; |
| 70 | AStructure : Structure from Graphic3d ) |
| 71 | is static; |
| 72 | ---Level: Public |
| 73 | ---Purpose: Modifies the PickPath <me>. |
| 74 | -- <AStructure> : Identifier of the structure picked. |
| 75 | ---Category: Methods to modify the class definition |
| 76 | |
| 77 | ---------------------------- |
| 78 | -- Category: Inquire methods |
| 79 | ---------------------------- |
| 80 | |
| 81 | ElementNumber ( me ) |
| 82 | returns Integer from Standard |
| 83 | ---Level: Public |
| 84 | ---Purpose: Returns the element number stocked in the PickPath <me>. |
| 85 | -- Category: Inquire methods |
| 86 | -- Warning: Raises PickError if PickPath is empty (no picked structure). |
| 87 | raises PickError from Visual3d is static; |
| 88 | |
| 89 | PickIdentifier ( me ) |
| 90 | returns Integer from Standard |
| 91 | ---Level: Public |
| 92 | ---Purpose: Returns the pick identifier stocked in the PickPath <me>. |
| 93 | -- Category: Inquire methods |
| 94 | -- Warning: Raises PickError if PickPath is empty (no picked structure). |
| 95 | raises PickError from Visual3d is static; |
| 96 | |
| 97 | StructIdentifier ( me ) |
| 98 | returns Structure from Graphic3d |
| 99 | ---Level: Public |
| 100 | ---Purpose: Returns the structure stocked in the PickPath <me>. |
| 101 | -- Category: Inquire methods |
| 102 | -- Warning: Raises PickError if PickPath is empty (no picked structure). |
| 103 | raises PickError from Visual3d is static; |
| 104 | |
| 105 | --\f |
| 106 | |
| 107 | fields |
| 108 | |
| 109 | -- |
| 110 | -- Class : Visual3d_PickPath |
| 111 | -- |
| 112 | -- Purpose : Declaration of variables specific to the class |
| 113 | -- describing a picking. |
| 114 | -- |
| 115 | -- Reminders : A pick is defined by : |
| 116 | -- - a vector (Elem_Num, Pick_Id, Structure) |
| 117 | -- |
| 118 | -- |
| 119 | |
| 120 | -- the pick vector |
| 121 | MyElementNumber : Integer from Standard; |
| 122 | MyPickId : Integer from Standard; |
| 123 | MyStructure : Structure from Graphic3d; |
| 124 | |
| 125 | -- the flag for definition |
| 126 | MyElementNumberIsDef : Boolean from Standard; |
| 127 | MyPickIdIsDef : Boolean from Standard; |
| 128 | MyStructureIsDef : Boolean from Standard; |
| 129 | |
| 130 | end PickPath; |
projects / occt.git / blame