// $Id: cxfnbmp.cpp 1282 2006-06-09 09:46:49Z alex $
/* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
================================XARAHEADERSTART===========================
 
               Xara LX, a vector drawing and manipulation program.
                    Copyright (C) 1993-2006 Xara Group Ltd.
       Copyright on certain contributions may be held in joint with their
              respective authors. See AUTHORS file for details.

LICENSE TO USE AND MODIFY SOFTWARE
----------------------------------

This file is part of Xara LX.

Xara LX is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.

Xara LX and its component source files are distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with Xara LX (see the file GPL in the root directory of the
distribution); if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


ADDITIONAL RIGHTS
-----------------

Conditional upon your continuing compliance with the GNU General Public
License described above, Xara Group Ltd grants to you certain additional
rights. 

The additional rights are to use, modify, and distribute the software
together with the wxWidgets library, the wxXtra library, and the "CDraw"
library and any other such library that any version of Xara LX relased
by Xara Group Ltd requires in order to compile and execute, including
the static linking of that library to XaraLX. In the case of the
"CDraw" library, you may satisfy obligation under the GNU General Public
License to provide source code by providing a binary copy of the library
concerned and a copy of the license accompanying it.

Nothing in this section restricts any of the rights you have under
the GNU General Public License.


SCOPE OF LICENSE
----------------

This license applies to this program (XaraLX) and its constituent source
files only, and does not necessarily apply to other Xara products which may
in part share the same code base, and are subject to their own licensing
terms.

This license does not apply to files in the wxXtra directory, which
are built into a separate library, and are subject to the wxWindows
license contained within that directory in the file "WXXTRA-LICENSE".

This license does not apply to the binary libraries (if any) within
the "libs" directory, which are subject to a separate license contained
within that directory in the file "LIBS-LICENSE".


ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
----------------------------------------------

Subject to the terms of the GNU Public License (see above), you are
free to do whatever you like with your modifications. However, you may
(at your option) wish contribute them to Xara's source tree. You can
find details of how to do this at:
  http://www.xaraxtreme.org/developers/

Prior to contributing your modifications, you will need to complete our
contributor agreement. This can be found at:
  http://www.xaraxtreme.org/developers/contribute/

Please note that Xara will not accept modifications which modify any of
the text between the start and end of this header (marked
XARAHEADERSTART and XARAHEADEREND).


MARKS
-----

Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
designs are registered or unregistered trademarks, design-marks, and/or
service marks of Xara Group Ltd. All rights in these marks are reserved.


      Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
                        http://www.xara.com/

=================================XARAHEADEREND============================
 */
/********************************************************************************************

>	cxfnbmp.cpp

	Author:		Andy_Hayward (Xara Group Ltd) <camelotdev@xara.com>
	Created:	14/06/96
	Purpose:	Implementation of an abstract class, holding code for exporting NodeBitmaps.

********************************************************************************************/

#include "camtypes.h"

#include "nodebmp.h"

//#include "camfiltr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "cxftags.h"
//#include "cxfdefs.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "cxfile.h"
//#include "cxfrec.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "cxfnbmp.h"

/********************************************************************************************

>	BOOL CXaraFileNodeBitmap::WritePreChildrenWeb(BaseCamelotFilter *pFilter, NodeBitmap *pNodeBitmap);
	BOOL CXaraFileNodeBitmap::WritePreChildrenNative(BaseCamelotFilter *pFilter, NodeBitmap *pNodeBitmap);

	Author:		Andy_Hayward (Xara Group Ltd) <camelotdev@xara.com>
	Created:	14/06/96
	Inputs:		pFilter - filter to save to
				pNodeBitmap - NodeBitmap to save
	Returns:	TRUE if successful, FALSE otherwise
	Purpose:	Saves a NodeBitmap record to the filter

********************************************************************************************/

BOOL CXaraFileNodeBitmap::WritePreChildrenWeb(BaseCamelotFilter *pFilter, NodeBitmap *pNodeBitmap)
{
	ERROR2IF(pFilter==NULL, FALSE, "parameter pFilter==NULL");
	ERROR2IF(pNodeBitmap==NULL, FALSE, "parameter pNodeBitmap==NULL");

	return WriteNodeBitmap(pFilter, pNodeBitmap);
}

BOOL CXaraFileNodeBitmap::WritePreChildrenNative(BaseCamelotFilter *pFilter, NodeBitmap *pNodeBitmap)
{
	ERROR2IF(pFilter==NULL, FALSE, "parameter pFilter==NULL");
	ERROR2IF(pNodeBitmap==NULL, FALSE, "parameter pNodeBitmap==NULL");

	return WriteNodeBitmap(pFilter, pNodeBitmap);
}

/********************************************************************************************

>	BOOL CXaraFileNodeBitmap::WriteNodeBitmap(BaseCamelotFilter *pFilter, NodeBitmap *pNodeBitmap)

	Author:		Andy_Hayward (Xara Group Ltd) <camelotdev@xara.com>
	Created:	14/06/96
	Inputs:		pFilter - filter to save to
				pNodeBitmap - NodeBitmap to save out
	Returns:	TRUE if successful, FALSE otherwise
	Purpose:	saves a NodeBitmap record to the filter

********************************************************************************************/

BOOL CXaraFileNodeBitmap::WriteNodeBitmap(BaseCamelotFilter *pFilter, NodeBitmap *pNodeBitmap)
{
	ERROR2IF(pFilter==NULL, FALSE, "parameter pFilter==NULL");
	ERROR2IF(pNodeBitmap==NULL, FALSE, "parameter pNodeBitmap==NULL");

	BOOL ok = TRUE;

	// save out the actual bitmap, and remember its record number
	INT32 BitmapRecordRef = 0;
	INT32 StartColourRecordRef = 0;
	INT32 EndColourRecordRef = 0;

	// Get the bitmap that the node references and hence we need to save.
	// Then get a reference to it. In the process this may save out the
	// bitmap definition, if it has not already been saved
	KernelBitmap *pBmp = pNodeBitmap->GetBitmap();
	// Complain if no bitmap was found	
	ERROR2IF(pBmp == NULL,FALSE,"CXaraFileNodeBitmap::WriteNodeBitmap pBmp is NULL");
	BitmapRecordRef = pFilter->WriteRecord(pBmp);
	ERROR2IF(BitmapRecordRef == 0,FALSE,"CXaraFileNodeBitmap::WriteNodeBitmap BitmapRecordRef is 0");

	// Do the same for the start and end colours (Contoning)
	// Only get a colour reference if they are present
	DocColour *pStartCol = pNodeBitmap->GetStartColour();
	if (pStartCol)
		StartColourRecordRef = pFilter->WriteRecord(pStartCol);
	DocColour *pEndCol = pNodeBitmap->GetEndColour();
	if (pEndCol)
		EndColourRecordRef = pFilter->WriteRecord(pEndCol);

	// BOOL Contoned = pNodeBitmap->GetApplyContoneColour();
	// The above flag may lie. If you have a 24bpp bitmap and have tried to apply a contone colour
	// and cancelled the operation, then this flag is set but there are no colours.
	// Check for the prescence of the colours and that they have been converted to colour references
	// ok. Only then, do we save a contoned bitmap.
	if (pStartCol != NULL && pEndCol != NULL &&
		StartColourRecordRef != 0 && EndColourRecordRef != 0 )
	{
		// Write out a contoned node bitmap record
		CamelotFileRecord Rec(pFilter,TAG_NODE_CONTONEDBITMAP, TAG_NODE_CONTONEDBITMAP_SIZE);
TRACEUSER( "Neville", _T("Write contoned node bitmap, bitmap reference %d, Start colour %d, EndColour %d\n"),BitmapRecordRef,StartColourRecordRef,EndColourRecordRef);
		if (ok) ok = Rec.Init();
		// Write out the encompassing rectangle
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[0]);
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[1]);
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[2]);
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[3]);
		// Write out the bitmap reference
		if (ok) ok = Rec.WriteReference(BitmapRecordRef);
		if (ok) ok = Rec.WriteReference(StartColourRecordRef);
		if (ok) ok = Rec.WriteReference(EndColourRecordRef);
		if (ok) ok = pFilter->Write(&Rec);
	}
	else
	{
		// Write out a normal node bitmap record
		CamelotFileRecord Rec(pFilter,TAG_NODE_BITMAP, TAG_NODE_BITMAP_SIZE);
TRACEUSER( "Neville", _T("Write node bitmap, bitmap reference %d\n"),BitmapRecordRef);
		if (ok) ok = Rec.Init();
		// Write out the encompassing rectangle
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[0]);
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[1]);
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[2]);
		if (ok) ok = Rec.WriteCoord(pNodeBitmap->Parallel[3]);
		// Write out the bitmap reference
		if (ok) ok = Rec.WriteReference(BitmapRecordRef);
		if (ok) ok = pFilter->Write(&Rec);
	}

	return ok;
}

