//===========================================================================//
// File:	Doorfram.hh                                                            //
// Project: Red Planet                                                       //
// Contents: Interface specification for doors                               //
//---------------------------------------------------------------------------//
//   Date    Who  Modification                                               //
// --------  ---  ---------------------------------------------------------- //
//                                                                           //
//---------------------------------------------------------------------------//
// Copyright (C) 1995, Virtual World Entertainment, Inc.                     //
// All Rights reserved worldwide                                             //
// This unpublished sourcecode is PROPRIETARY and CONFIDENTIAL               //
//===========================================================================//

#if !defined(DOORFRAM_HPP)
#	define DOORFRAM_HPP

#	if !defined(TERRAIN_HPP)
#		include <terrain.hpp>
#	endif


	//##########################################################################
	//#############################    DoorFrame    ################################
	//##########################################################################

	class DoorFrame:
		public UnscalableTerrain
	{
	public:
	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Test Instance support
	//
		Logical
			TestInstance() const;

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Shared Data support
	//
	public:
		static Derivation ClassDerivations;
		static SharedData DefaultData;

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Model support
	//
	enum{
		BasicSubsystemCount
	};

	public:
		typedef void
			(DoorFrame::*Performance)(Scalar time_slice);

		void
			SetPerformance(Performance performance)
				{
					Check(this);
					activePerformance = (Simulation::Performance)performance;
				}

	//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// Construction and Destruction
	//
	public:
		static Logical
			CreateMakeMessage(
				MakeMessage *creation_message,
				NotationFile *model_file,
				const ResourceDirectories *directories
			);
		static ResourceDescription::ResourceID
			CreateSubsystemStream(
				ResourceFile *resource_file,
				const char *model_name,
				NotationFile *model_file,
				const ResourceDirectories *directories
			);

		static DoorFrame*
			Make(MakeMessage *creation_message);

		DoorFrame(
			MakeMessage *creation_message,
			SharedData &virtual_data = DefaultData
		);
		~DoorFrame();
	};

#endif