[occt.git] / src / AIS2D / AIS2D_LocalStatus.cdl

-- File     : AIS2D_LocalStatus.cdl
-- Created  : February  2000
-- Author   : Tanya COOL
---Copyright: Matra Datavision 2000

private class LocalStatus from AIS2D inherits TShared from MMgt

   ---Purpose: Stored Info about temporary objects.

uses 

    ListOfInteger   from TColStd,
	NameOfColor     from Quantity,
    PToListOfInt    from AIS2D,
    TypeOfDetection from AIS2D
is

    Create( isTemporary   : Boolean         from Standard = Standard_True;
    	    Decompose     : Boolean         from Standard = Standard_False; 
    	    DMode         : Integer         from Standard = -1;
    	    SMode         : Integer         from Standard = -1; 
	        HMode         : TypeOfDetection from AIS2D    = AIS2D_TOD_PRIMITIVE;
    	    SubIntensity  : Boolean         from Standard = 0;
    	    HighlCol      : NameOfColor     from Quantity = Quantity_NOC_WHITE )
     returns mutable LocalStatus from AIS2D;
    ---Purpose: Initializes the default Local Status

    Decomposed( me ) returns Boolean from Standard; 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 
    
    IsTemporary( me ) returns Boolean from Standard; 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    DisplayMode( me ) returns Integer from Standard; 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SelectionModes( me: mutable ) returns PToListOfInt from AIS2D; 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    IsActivated( me; aSelMode: Integer from Standard ) returns Boolean from Standard;
    ---Level: Internal
    ---Purpose: 

    HighlightMode( me ) returns TypeOfDetection from AIS2D; 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    IsSubIntensityOn( me ) returns Boolean from Standard; 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    HighlightColor( me ) returns NameOfColor from Quantity; 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    IsFirstDisplay( me ) returns Boolean from  Standard;
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SetDecomposition( me:mutable; aStatus: Boolean from Standard); 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SetTemporary( me:mutable; aStatus: Boolean from Standard); 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SetDisplayMode( me:mutable; aMode: Integer from Standard); 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SetFirstDisplay( me:mutable; aStatus: Boolean  from  Standard) ; 
    ---C++: inline    
    ---Level: Internal      
    ---Purpose: 

    AddSelectionMode( me:mutable; aMode: Integer from Standard );
    ---Level: Internal
    ---Purpose: 

    RemoveSelectionMode( me:mutable; aMode: Integer from Standard );
    ---Level: Internal
    ---Purpose: 

    ClearSelectionModes( me:mutable );
    ---Level: Internal
    ---Purpose: 

    IsSelModeIn( me; aMode: Integer from Standard ) returns Boolean from Standard;    
    ---Level: Internal
    ---Purpose: 

    SetHighlightMode( me: mutable; aMode: TypeOfDetection from AIS2D ); 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SetHighlightColor( me: mutable; aHiCol: NameOfColor from Quantity ); 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SubIntensityOn( me:mutable ); 
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

    SubIntensityOff( me:mutable );
    ---Level: Internal
    ---Purpose: 

    SetPreviousState( me:mutable; aStatus: Transient from Standard ); 
    ---Level: Internal
    ---Purpose: 

    PreviousState( me ) returns any Transient from Standard;
    ---C++: inline
    ---Level: Internal
    ---Purpose: 

fields

    myDecomposition : Boolean         from Standard;
    myIsTemporary   : Boolean         from Standard;
    myDMode         : Integer         from Standard; 
    myFirstDisplay  : Boolean         from Standard;
    myHMode         : TypeOfDetection from AIS2D;
    mySModes        : ListOfInteger   from TColStd;
    mySubIntensity  : Boolean         from Standard;
    myHighlCol      : NameOfColor     from Quantity;
    myPrevState     : Transient       from Standard;
    
end LocalStatus;
Commit	Line	Data
7fd59977	1	-- File : AIS2D_LocalStatus.cdl
	2	-- Created : February 2000
	3	-- Author : Tanya COOL
	4	---Copyright: Matra Datavision 2000
	5
	6	private class LocalStatus from AIS2D inherits TShared from MMgt
	7
	8	---Purpose: Stored Info about temporary objects.
	9
	10	uses
	11
	12	ListOfInteger from TColStd,
	13	NameOfColor from Quantity,
	14	PToListOfInt from AIS2D,
	15	TypeOfDetection from AIS2D
	16	is
	17
	18	Create( isTemporary : Boolean from Standard = Standard_True;
	19	Decompose : Boolean from Standard = Standard_False;
	20	DMode : Integer from Standard = -1;
	21	SMode : Integer from Standard = -1;
	22	HMode : TypeOfDetection from AIS2D = AIS2D_TOD_PRIMITIVE;
	23	SubIntensity : Boolean from Standard = 0;
	24	HighlCol : NameOfColor from Quantity = Quantity_NOC_WHITE )
	25	returns mutable LocalStatus from AIS2D;
	26	---Purpose: Initializes the default Local Status
	27
	28	Decomposed( me ) returns Boolean from Standard;
	29	---C++: inline
	30	---Level: Internal
	31	---Purpose:
	32
	33	IsTemporary( me ) returns Boolean from Standard;
	34	---C++: inline
	35	---Level: Internal
	36	---Purpose:
	37
	38	DisplayMode( me ) returns Integer from Standard;
	39	---C++: inline
	40	---Level: Internal
	41	---Purpose:
	42
	43	SelectionModes( me: mutable ) returns PToListOfInt from AIS2D;
	44	---C++: inline
	45	---Level: Internal
	46	---Purpose:
	47
	48	IsActivated( me; aSelMode: Integer from Standard ) returns Boolean from Standard;
	49	---Level: Internal
	50	---Purpose:
	51
	52	HighlightMode( me ) returns TypeOfDetection from AIS2D;
	53	---C++: inline
	54	---Level: Internal
	55	---Purpose:
	56
	57	IsSubIntensityOn( me ) returns Boolean from Standard;
	58	---C++: inline
	59	---Level: Internal
	60	---Purpose:
	61
	62	HighlightColor( me ) returns NameOfColor from Quantity;
	63	---C++: inline
	64	---Level: Internal
65	---Purpose:
66
67	IsFirstDisplay( me ) returns Boolean from Standard;
68	---C++: inline
69	---Level: Internal
70	---Purpose:
71
72	SetDecomposition( me:mutable; aStatus: Boolean from Standard);
73	---C++: inline
74	---Level: Internal
75	---Purpose:
76
77	SetTemporary( me:mutable; aStatus: Boolean from Standard);
78	---C++: inline
79	---Level: Internal
80	---Purpose:
81
82	SetDisplayMode( me:mutable; aMode: Integer from Standard);
83	---C++: inline
84	---Level: Internal
85	---Purpose:
86
87	SetFirstDisplay( me:mutable; aStatus: Boolean from Standard) ;
88	---C++: inline
89	---Level: Internal
90	---Purpose:
91
92	AddSelectionMode( me:mutable; aMode: Integer from Standard );
93	---Level: Internal
94	---Purpose:
95
96	RemoveSelectionMode( me:mutable; aMode: Integer from Standard );
97	---Level: Internal
98	---Purpose:
99
100	ClearSelectionModes( me:mutable );
101	---Level: Internal
102	---Purpose:
103
104	IsSelModeIn( me; aMode: Integer from Standard ) returns Boolean from Standard;
105	---Level: Internal
106	---Purpose:
107
108	SetHighlightMode( me: mutable; aMode: TypeOfDetection from AIS2D );
109	---C++: inline
110	---Level: Internal
111	---Purpose:
112
113	SetHighlightColor( me: mutable; aHiCol: NameOfColor from Quantity );
114	---C++: inline
115	---Level: Internal
116	---Purpose:
117
118	SubIntensityOn( me:mutable );
119	---C++: inline
120	---Level: Internal
121	---Purpose:
122
123	SubIntensityOff( me:mutable );
124	---Level: Internal
125	---Purpose:
126
127	SetPreviousState( me:mutable; aStatus: Transient from Standard );
128	---Level: Internal
129	---Purpose:
130
131	PreviousState( me ) returns any Transient from Standard;
132	---C++: inline
133	---Level: Internal
134	---Purpose:
135
136	fields
137
138	myDecomposition : Boolean from Standard;
139	myIsTemporary : Boolean from Standard;
140	myDMode : Integer from Standard;
141	myFirstDisplay : Boolean from Standard;
142	myHMode : TypeOfDetection from AIS2D;
143	mySModes : ListOfInteger from TColStd;
144	mySubIntensity : Boolean from Standard;
145	myHighlCol : NameOfColor from Quantity;
146	myPrevState : Transient from Standard;
147
148	end LocalStatus;