[occt.git] / src / Graphic3d / Graphic3d_GraphicDevice.cdl

-- Created on: 1994-01-19
-- Created by: CAL
-- Copyright (c) 1994-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.

-- Modified:	GG RIC120302 add new constructor to pass Display structure
--		directly instead the connexion name.

class GraphicDevice from Graphic3d inherits GraphicDevice from Xw 

---Purpose: This class allows the definition of the Advanced
	--	    Graphic Device 
-- Warning: An Graphic Device is defined by a connexion
	--	    "host:server.screen" 


uses

	SharedLibrary	from OSD,
	GraphicDriver	from Aspect,
	Display		from Aspect,
	GraphicDriver	from Graphic3d,
	TypeOfMapping	from Xw,
	AsciiString     from TCollection

raises

	GraphicDeviceDefinitionError	from Aspect

is

	Create ( Connexion	: CString from Standard;
		 Mapping	: TypeOfMapping from Xw = Xw_TOM_COLORCUBE;
		 Ncolors	: Integer from Standard = 0;
		 UseDefault	: Boolean from Standard = Standard_True ) 
	returns mutable GraphicDevice from Graphic3d 
	---Level: Public
	---Purpose: Creates a GraphicDevice
	---Warning: Raises if the Device is badly defined
	raises GraphicDeviceDefinitionError from Aspect;

	Create ( DisplayHandle	: Display from Aspect)
	returns mutable GraphicDevice from Graphic3d 
	---Level: Public
	---Purpose: Creates a GraphicDevice from the Display structure
	---Warning: Raises if the Device is badly defined
	raises GraphicDeviceDefinitionError from Aspect;

	Destroy ( me	: mutable )
		is redefined static;
	---Level: Public
	---Purpose: Deletes the GraphicDevice <me>.
	---C++: alias ~

	GraphicDriver ( me )
		returns GraphicDriver from Aspect
		is redefined static;
	---Level: Public
	---Purpose: Returns the GraphicDriver.

	SetGraphicDriver ( me	: mutable )
		is private;
	---Level: Internal
	---Purpose: Sets the GraphicDriver.

	ShrEnvString ( me )
		returns AsciiString from TCollection
		is private;
	---Level: Internal
	---Purpose: Returns the environment string for loading shared graphics library.
	--	    The string can be defined in environment by corresponding variables,
	--      or default value will be used for loading from system library path
	--	    Environment variables : CSF_GraphicShr

fields

	MyGraphicDriver	:	GraphicDriver from Graphic3d;

end GraphicDevice from Graphic3d;
Commit	Line	Data
b311480e	1	-- Created on: 1994-01-19
	2	-- Created by: CAL
	3	-- Copyright (c) 1994-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977	5	--
b311480e	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
7fd59977	21	-- Modified: GG RIC120302 add new constructor to pass Display structure
7fd59977	22	-- directly instead the connexion name.
7fd59977	23
	24	class GraphicDevice from Graphic3d inherits GraphicDevice from Xw
	25
	26	---Purpose: This class allows the definition of the Advanced
	27	-- Graphic Device
	28	-- Warning: An Graphic Device is defined by a connexion
	29	-- "host:server.screen"
	30
	31
	32	uses
	33
	34	SharedLibrary from OSD,
	35	GraphicDriver from Aspect,
	36	Display from Aspect,
	37	GraphicDriver from Graphic3d,
86be4295 A	38	TypeOfMapping from Xw,
86be4295 A	39	AsciiString from TCollection
7fd59977	40
	41	raises
	42
	43	GraphicDeviceDefinitionError from Aspect
	44
	45	is
	46
	47	Create ( Connexion : CString from Standard;
	48	Mapping : TypeOfMapping from Xw = Xw_TOM_COLORCUBE;
	49	Ncolors : Integer from Standard = 0;
	50	UseDefault : Boolean from Standard = Standard_True )
	51	returns mutable GraphicDevice from Graphic3d
	52	---Level: Public
	53	---Purpose: Creates a GraphicDevice
	54	---Warning: Raises if the Device is badly defined
	55	raises GraphicDeviceDefinitionError from Aspect;
	56
	57	Create ( DisplayHandle : Display from Aspect)
	58	returns mutable GraphicDevice from Graphic3d
	59	---Level: Public
	60	---Purpose: Creates a GraphicDevice from the Display structure
	61	---Warning: Raises if the Device is badly defined
	62	raises GraphicDeviceDefinitionError from Aspect;
	63
	64	Destroy ( me : mutable )
	65	is redefined static;
	66	---Level: Public
	67	---Purpose: Deletes the GraphicDevice <me>.
	68	---C++: alias ~
	69
	70	GraphicDriver ( me )
	71	returns GraphicDriver from Aspect
	72	is redefined static;
	73	---Level: Public
	74	---Purpose: Returns the GraphicDriver.
	75
	76	SetGraphicDriver ( me : mutable )
	77	is private;
	78	---Level: Internal
	79	---Purpose: Sets the GraphicDriver.
	80
86be4295 A	81	ShrEnvString ( me )
86be4295 A	82	returns AsciiString from TCollection
7fd59977	83	is private;
7fd59977	84	---Level: Internal
86be4295 A	85	---Purpose: Returns the environment string for loading shared graphics library.
	86	-- The string can be defined in environment by corresponding variables,
	87	-- or default value will be used for loading from system library path
	88	-- Environment variables : CSF_GraphicShr
7fd59977	89
	90	fields
	91
	92	MyGraphicDriver : GraphicDriver from Graphic3d;
	93
	94	end GraphicDevice from Graphic3d;