FlashRenderRegion Class Reference

Provides the necessary functions to convert image data stored in the Camelot tree into the correct values for exporting to the Flash 4 format, and output these to the relevant device context. More...

#include <swfrndr.h>

Inheritance diagram for FlashRenderRegion:

List of all members.

Public Member Functions
	FlashRenderRegion (void)
	Constructor for the FlashRenderRegion class.
	FlashRenderRegion (DocRect ClipRect, Matrix ConvertMatrix, FIXED16 ViewScale)
	Constructor for the FlashRenderRegion class.
	~FlashRenderRegion (void)
	Destructor for the FlashRenderRegion class.
BOOL	ExportCharacter (TextChar *pTheLetter)
	Adds the character into the two lists that maintain the strings to be exported to a Flash file.
BOOL	ExportBevel (NodeBevel *pBevel)
	Creates a shape record for the bevel's path, and a bitmap fill to do the bevel. It can currently only accurately reproduce bevels with flat fills, since Flash's support of transparent bitmaps is broken at the moment.
BOOL	ExportBevelBegin (NodeBevelBegin *pBevel)
	Stub function to prevent NodeBevelBegin from rendering.
BOOL	ExportShadow (Path *pShadowPath, OILBitmap *pBitmap, UINT32 Darkness)
	Creates a shape record for a shadow, and stores it inside the Flash file.
BOOL	ExportRenderableNode (NodeRenderableInk *pInk)
	Renders a stroked path to the file.
BOOL	ExportAll (void)
	Most of the functions within the FlashRenderRegion class are used to create and populate a series of linked lists which contain a processed version of the Camelot tree. This function passes all of these lists to the Render DC, so that they can be outputted to a file, and then cleans up the objects to prevent any memory leaks.
void	SetButtonName (TCHAR *pButtonName)
	Sets the name of the current button being exported. If the object being exported doesn't have this attribute, the string is cleared to prevent problems with old button names persisting.
void	SetLayerState (LayerState State)
	Sets the value to mButtonState to be State. This is used to determine which of the roll-over states of a button and which object should be used.
Protected Member Functions
void	DrawPathToOutputDevice (Path *PathToRender, PathShape shapePath=PATHSHAPE_PATH)
	Outputs a path to the device context.
void	InitPointers (void)
	Initialises all pointer values to NULL.
BOOL	ProcessPath (Path *pPath)
	Writes all the path attributes to a Flash shape record object, in preparation for storing it in the file.
BOOL	ProcessFill (FillGeometryAttribute *pFill, TranspFillAttribute *pTransparency)
BOOL	ProcessColour (FillGeometryAttribute *pFill)
	Processes the FillGeometryAttribute of a shape, and fills in the correct fill attributes into the FlashShapeRecord referenced by mpShapeTail.
BOOL	ProcessTransparency (TranspFillAttribute *pTransparency, FillGeometryAttribute *pFill)
	Processes the TranspFillAttribute of a shape, and fills in the correct fill attributes into the FlashShapeRecord referenced by mpShapeTail.
BOOL	CreateTextRecord (TextChar *pTheLetter)
	Creates a new FlashTextRecord, which is used to store a text character.
BOOL	ProcessFlatFill (DocColour *pColour)
	Processes a flat fill, and writes the correct values to the file record.
BOOL	ProcessGradientFill (DocColour *pStartColour, DocColour *pMidColour, DocColour *pEndColour, ColourRamp *pRamp, DocCoord *pStartPoint, DocCoord *pEndPoint, DocCoord *pEndPoint2, BYTE FillType)
	Processes a gradient fill, and writes the correct values to the file record.
BOOL	ProcessBitmapFill (FillGeometryAttribute *pFill)
	Processes a bitmap fill, and writes the correct values to the file record.
BOOL	RecordBitmapFill (BitmapFillAttribute *pFill, WORD BitmapID)
	Records the details of a bitmap fill into a shape record, so that it can be stored within a Flash file.
WORD	GetBitmapID (OILBitmap *pBitmap, DocColour *pStartColour, DocColour *pEndColour, UINT32 Transparency)
	Spools through the list of bitmaps, and returns the appropriate bitmap reference. Note: Bevel bitmaps are treated as being contoned, though the process by which their palette is generated is slightly different.
BOOL	ProcessFlatTransp (UINT32 Transparency)
	Processes a flat transparency, and writes the correct values to the file record.
BOOL	ProcessGradientTransp (UINT32 *pStartTransparency, UINT32 *pMidTransparency, UINT32 *pEndTransparency, DocCoord *pStartPoint, DocCoord *pEndPoint, DocCoord *pEndPoint2, BYTE FillType)
	Processes a gradient transparency, and writes the correct values to the file record.
BOOL	ProcessBitmapTransp (TranspFillAttribute *pTransparency, FillGeometryAttribute *pFill)
	Processes a bitmap fill, and writes the correct values to the file record. There were problems with Flash 4 to do with rendering transparent bitmaps, and so this was removed. Flash 5 seems to have cured them, and so this function has ben re-instated.
UINT32	BlendTransparencies (UINT32 *pStart, UINT32 *pEnd1, UINT32 *pEnd2, UINT32 *pEnd3)
	Calculates the average value for the transparency of a shape.
DocColour	BlendColours (DocColour *pStart, DocColour *pEnd1, DocColour *pEnd2, DocColour *pEnd3, ColourRamp *pRamp)
	Calculates the average value for the fill colour of a shape, along with the contents of any colour ramp.
FlashButtonRecord *	ProcessURL (WebAddressAttribute *pWebAddress)
	Processes a WebAddressAttribute, and stores the details in a FlashButtonRecord for processing in the Export DC.
BOOL	ExportButtonState (FlashButtonRecord *pButton)
	This method is part of the button rollover support that is being added to the Flash export filter. Due to the way that the render region has been implemented, and the fact that I've been asked to do this after writing virtually all of the filter code, it's algorithm is a little strange.
FlashButtonRecord *	MatchButton (void)
	Spools through the list of button records (pointed to by mpButton), and attempts to match the sprite with the input parameters. If no match is made, a new button record is created, and populated with the correct values.
FlashSprite *	MatchSprite (FlashButtonRecord *pButton)
	Spools through the list of sprite records (pointed to by mpSprite), and attempts to match the sprite with the input parameters. If no match is made, a new sprite record is created, and populated with the correct name and LayerState.
BOOL	PlaceObject (WORD ID, FlashType ToRender, DocCoord *pPosition=NULL, BOOL DoTransform=FALSE)
	Creates a FlashPlaceObject record for the object with the corresponding ID.
Protected Attributes
FlashBitmapRecord *	mpBitmap
FlashBitmapRecord *	mpBitmapTail
FlashTextRecord *	mpText
FlashTextRecord *	mpTextTail
FlashFontRecord *	mpFont
FlashFontRecord *	mpFontTail
FlashShapeRecord *	mpShape
FlashShapeRecord *	mpShapeTail
FlashShapeRecord *	mpShapeLast
FlashButtonRecord *	mpButton
FlashButtonRecord *	mpButtonTail
FlashSprite *	mpSprite
FlashSprite *	mpSpriteTail
FlashPlaceObject *	mpPlace
FlashPlaceObject *	mpPlaceTail
String_256	mButtonName
LayerState	mButtonState
BOOL	mSupressLines
BOOL	mExportStroke

---

Detailed Description

Provides the necessary functions to convert image data stored in the Camelot tree into the correct values for exporting to the Flash 4 format, and output these to the relevant device context.

Author:

Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>

Date:

24/8/99

Definition at line 234 of file swfrndr.h.

---

Constructor & Destructor Documentation

FlashRenderRegion::FlashRenderRegion (  void   )

Constructor for the FlashRenderRegion class. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/99 See also: FlashFilter::Init Definition at line 142 of file swfrndr.cpp. : VectorFileRenderRegion () { // Ensure that member variable pointers are set to NULL. InitPointers (); }

FlashRenderRegion::FlashRenderRegion (  DocRect  ClipRect, Matrix  ConvertMatrix, FIXED16  ViewScale )

Constructor for the FlashRenderRegion class. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/99 See also: FlashFilter::Init Definition at line 162 of file swfrndr.cpp. : VectorFileRenderRegion ( ClipRect, ConvertMatrix, ViewScale ) { // Ensure that member variable pointers are set to NULL. InitPointers (); }

FlashRenderRegion::~FlashRenderRegion (  void   )

Destructor for the FlashRenderRegion class. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 24/8/99 See also: - Definition at line 182 of file swfrndr.cpp. { // Insert clean up code here! if(mpFont) { delete mpFont; mpFont = NULL; } InitPointers (); }

---

Member Function Documentation

DocColour FlashRenderRegion::BlendColours (  DocColour *  pStart, DocColour *  pEnd1, DocColour *  pEnd2, DocColour *  pEnd3, ColourRamp *  pRamp )  [protected]

Calculates the average value for the fill colour of a shape, along with the contents of any colour ramp. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/99 Returns: The average value of pStart, pEnd1, pEnd2, and pEnd3. See also: FlashRenderRegion::ProcessTransparency () Definition at line 2018 of file swfrndr.cpp. { // Declare and initialise the local variables. DocColour Result; INT32 TotalRed = 0; INT32 TotalGreen = 0; INT32 TotalBlue = 0; INT32 Count = 1; INT32 Red, Green, Blue; // Extract the colours from the DocColour. if ( pStart != NULL ) { pStart->GetRGBValue ( &TotalRed, &TotalGreen, &TotalBlue ); } // I've nested the following if statements for efficiency, since (e.g.) if pEnd1 is // NULL, pEnd2 and pEnd3 will also be NULL. if ( pEnd1 != NULL ) { // Extract the colours from the DocColour. pEnd1->GetRGBValue ( &Red, &Green, &Blue ); TotalRed += Red; TotalGreen += Green; TotalBlue += Blue; Count ++; // Call the second if, for pEnd2. if ( pEnd2 != NULL ) { // Extract the colours from the DocColour. pEnd2->GetRGBValue ( &Red, &Green, &Blue ); TotalRed += Red; TotalGreen += Green; TotalBlue += Blue; Count ++; // And finally for pEnd3. if ( pEnd3 != NULL ) { // Extract the colours from the DocColour. pEnd3->GetRGBValue ( &Red, &Green, &Blue ); TotalRed += Red; TotalGreen += Green; TotalBlue += Blue; Count ++; } } } // Process the colour ramp. if ( pRamp != NULL ) { ColRampItem *pColour = pRamp->GetFirstCol (); // Write in the ramp's colour values. while ( pColour != NULL ) { // Get the position of the colour in the fill. DocColour RampColour = pColour->GetColour (); // Extract the colour. RampColour.GetRGBValue ( &Red, &Green, &Blue ); TotalRed += Red; TotalGreen += Green; TotalBlue += Blue; Count ++; // Increment the pointer onto the next item. pColour = pRamp->GetNextCol ( pColour ); } } // Divide the Total* values by Count to get the average colour. TotalRed /= Count; TotalGreen /= Count; TotalBlue /= Count; Result.SetRGBValue ( TotalRed, TotalGreen, TotalBlue ); return Result; }

UINT32 FlashRenderRegion::BlendTransparencies (  UINT32 *  pStart, UINT32 *  pEnd1, UINT32 *  pEnd2, UINT32 *  pEnd3 )  [protected]

Calculates the average value for the transparency of a shape. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 7/12/99 Returns: The average value of pStart, pEnd1, pEnd2, and pEnd3. See also: FlashRenderRegion::ProcessTransparency () Definition at line 1964 of file swfrndr.cpp. { // Declare and initialise the local variables. UINT32 Result = *pStart; UINT32 Count = 1; // I've nested the following if statements for efficiency, since (e.g.) if pEnd1 is // NULL, pEnd2 and pEnd3 will also be NULL. if ( pEnd1 != NULL ) { Result += *pEnd1; Count ++; // Call the second if, for pEnd2. if ( pEnd2 != NULL ) { Result += *pEnd2; Count ++; // And finally for pEnd3. if ( pEnd3 != NULL ) { Result += *pEnd3; Count ++; } } } // Divide Result by Count to get the average transparency. Result /= Count; return Result; }

BOOL FlashRenderRegion::CreateTextRecord (  TextChar *  pTheLetter  )  [protected]

Creates a new FlashTextRecord, which is used to store a text character. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 26/11/99 Returns: TRUE if success. See also: FlashRenderRegion::ExportCharacter () Definition at line 1180 of file swfrndr.cpp. { // Define local variables. TextLine *pTextLine = pTheLetter->FindParentLine (); DocRect Bounds = pTextLine->GetBoundingRect (); WORD ID = FlashPlaceObject::GetTextCount (); FlashType ToRender = FLASH_TEXT; WebAddressAttribute *pWebAddress = ( WebAddressAttribute * ) GetCurrentAttribute ( ATTR_WEBADDRESS ); FlashButtonRecord *pButton = NULL; Matrix TextMatrix; FIXED16 MatrixValues [4]; INT32 Translate [2]; DocCoord LowCorner; // If no text records, create one. if ( mpText == NULL ) { mpText = new FlashTextRecord; ASSERT ( mpText != NULL ); mpTextTail = mpText; } else { // mpTextTail points at the tail of the list. mpTextTail = mpTextTail->AddElement (); ASSERT ( mpTextTail != NULL ); } // Set ID. mpTextTail->SetTextID ( FlashPlaceObject::GetTextCount () ); // Set aspect ratio. mpTextTail->SetAspect ( ( ( TxtAspectRatioAttribute* ) GetCurrentAttribute ( ATTR_TXTASPECTRATIO ) )->AspectRatio ); // Set the bounding box. mpTextTail->SetBounds ( Bounds ); // Get the text story matrix... pTheLetter->GetStoryAndCharMatrix ( &TextMatrix ); TextMatrix.GetComponents ( MatrixValues, Translate ); // ... and store it. mpTextTail->SetScaleX ( MatrixValues [0].GetRawLong () ); mpTextTail->SetScaleY ( MatrixValues [3].GetRawLong () ); mpTextTail->SetSkewX ( MatrixValues [1].GetRawLong () ); mpTextTail->SetSkewY ( MatrixValues [2].GetRawLong () ); // Record the text's web address. pButton = ProcessURL ( pWebAddress ); // Add a PlaceObject record. LowCorner.x = Translate [0]; // Calculate the x position. LowCorner.y = Translate [1]; // And also the y position. PlaceObject ( ID, ToRender, &LowCorner, TRUE ); // Then create the FlashPlaceObject. // Export any button states that might have been created. ExportButtonState ( pButton ); return TRUE; }

void FlashRenderRegion::DrawPathToOutputDevice (  Path *  PathToRender, PathShape  shapePath = PATHSHAPE_PATH )  [protected, virtual]

Outputs a path to the device context. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 7/9/99 Returns: Void See also: RenderRegion::InitDevice Implements RenderRegion. Definition at line 207 of file swfrndr.cpp. { // Step 1: Define, and set up all the local variables. FlashButtonRecord *pButton = NULL; DocRect Bounds; DocCoord LowCorner; WebAddressAttribute *pWebAddress = ( WebAddressAttribute * ) GetCurrentAttribute ( ATTR_WEBADDRESS ); // Step 2: Initialise the path, and use the clipping routines to re-order the path to // wind in the correct manner for the Flash editing tools to understand. Though // the player operates with an even-odd winding rule, the editing tools don't, // so this operations is necessary. // We only clip if the path is closed, otherwise rendering artefacts occur. if ( PathToRender->IsClosed () ) { // Declare a path for storing the clipped path in. Path ClippedPath; // Initialise the path before using it. ClippedPath.Initialise ( PathToRender->GetNumCoords () ); // Set up the path to point in the right direction using ClipPathToPath. ClippedPath.ClipPathToPath ( *PathToRender, &ClippedPath, 3, 20 ); // Store the path. ProcessPath ( &ClippedPath ); } else { // Store the path. ProcessPath ( PathToRender ); } // Step 3: If the shape has a web address, create a FlashButtonRecord, and add the // shape's ID number to this instead. Because exporting button states can // alter the list of FlashPlaceObjects, it is necessary to create any buttons // here. pButton = ProcessURL ( pWebAddress ); // Step 4: Add a FlashPlaceObject record. // Set up the position for the place object record... Bounds = mpShapeTail->GetBoundingBox (); LowCorner.x = Bounds.lo.x; LowCorner.y = Bounds.hi.y; // ... and create it. PlaceObject ( FlashPlaceObject::GetShapeCount (), FLASH_SHAPE, &LowCorner, TRUE ); // Step 5: Export any button states that have been created. ExportButtonState ( pButton ); }

BOOL FlashRenderRegion::ExportAll (  void   )

Most of the functions within the FlashRenderRegion class are used to create and populate a series of linked lists which contain a processed version of the Camelot tree. This function passes all of these lists to the Render DC, so that they can be outputted to a file, and then cleans up the objects to prevent any memory leaks. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 20/10/99 Input: - Returns: TRUE if success. See also: - Definition at line 959 of file swfrndr.cpp. { // These functions all depend on the objects used by the linked list having the pointer // to the next instance being initialised to NULL when they are created. If this isn't // done, this function will throw an error, since the code will attempt to access // uncreated objects. // (ChrisG 18/1/01) Added an error box to warn if a shape is detected that's too big to // render properly when imported into Flash/Internet Browsers, etc... BOOL invalidSizeFound = FALSE; // Step 1: Get a device context to the Flash file. FlashExportDC *pFlashDC = ( FlashExportDC * ) CCDC::ConvertFromNativeDC(RenderRegion::GetRenderDC()); TRACEUSER( "Graeme", _T("Entering ExportAll!\n") ); FlashBitmapRecord *pLastBitmap = NULL; // Step 2: Delete the bitmap records. while ( mpBitmap != NULL ) { // The bitmap records have already been exported, so just delete the list. pLastBitmap = mpBitmap; mpBitmap = mpBitmap->GetNext(); // (ChrisG 4/1/01) - These two calls have been removed, as they cause access violations // with temporary bitmaps (e.g. in blends), as the bitmaps have already been deleted. // pLastBitmap->GetBitmap()->DestroyContonePalette(); // pLastBitmap->GetBitmap()->DestroyGreyscaleVersion(); delete pLastBitmap; } FlashFontRecord *pLastFont = NULL; // Step 3: Export and delete the font records. while ( mpFont != NULL ) { pLastFont = mpFont; // Write out the font definitions to the file. pFlashDC->WriteDefineFont ( mpFont ); mpFont = mpFont->GetNext (); delete pLastFont; } FlashTextRecord *pLastText = NULL; // Step 4: Export and delete the text string records. while ( mpText != NULL ) { pLastText = mpText; // Write out the text strings to the file. pFlashDC->WriteText ( mpText ); mpText = mpText->GetNext (); delete pLastText; } // Step 5: Export and delete the shape records. while ( mpShape != NULL ) { FlashShapeRecord *pLastShape = mpShape; // Write out the shapes. pFlashDC->WritePath ( mpShape ); // (ChrisG 18/1/01) Check to see whether the shape's size is valid if (pLastShape->WasInvalidSizeFound () == TRUE) { invalidSizeFound = TRUE; } mpShape = mpShape->GetNext (); delete pLastShape; } // Step 6: Export and delete the sprite records. while ( mpSprite != NULL ) { FlashSprite *pLastSprite = mpSprite; // Write out the sprites. pFlashDC->ProcessSprite ( mpSprite, mpButton ); mpSprite = mpSprite->GetNext (); delete pLastSprite; } // Step 7: Export and delete the button records. while ( mpButton != NULL ) { FlashButtonRecord *pLastButton = mpButton; // Write out the buttons. pFlashDC->WriteURLScript ( mpButton ); mpButton = mpButton->GetNext (); delete pLastButton; } // Step 8: Export and delete the place object classes. while ( mpPlace != NULL ) { FlashPlaceObject *pLastPlace = mpPlace; // Write out the place object tags. pFlashDC->WritePlaceObject ( mpPlace ); mpPlace = mpPlace->GetNext (); delete pLastPlace; } // Step 9: Reset all pointer values. InitPointers (); // Warn of any invalid shapes that were detected. if (invalidSizeFound == TRUE) { // Display error message. String_256 WarnMsg; WarnMsg.MakeMsg(_R(IDT_FLASH_INVALID_SIZE_WARNING)); Error::SetError(0, WarnMsg, 0); } return TRUE; }

BOOL FlashRenderRegion::ExportBevel (  NodeBevel *  pBevel  )

Creates a shape record for the bevel's path, and a bitmap fill to do the bevel. It can currently only accurately reproduce bevels with flat fills, since Flash's support of transparent bitmaps is broken at the moment. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/99 Input: pBevel - A pointer to a NodeBevel object. Returns: TRUE if success. See also: - Definition at line 647 of file swfrndr.cpp. { // Set up the range control flags. RangeControl ControlFlags ( TRUE, TRUE ); Range ToRender ( pBevel, pBevel, ControlFlags ); OILBitmap *pBitmap = NULL; KernelBitmap *pKernBitmap = NULL; Path *pSourcePath = &( pBevel->InkPath ); Path BevelPath; // Create and render the bitmap. pKernBitmap = pBevel->CreateBitmapCopy(-1.0,FALSE); pBitmap = pKernBitmap->ActualBitmap; // Initialise the path, and copy the data into it. BevelPath.Initialise ( pSourcePath->GetNumCoords () ); if ( BevelPath.CopyPathDataFrom ( &( pBevel->InkPath ) ) == FALSE ) { TRACEUSER( "Graeme", _T("Error, and exiting ExportBevel!\n") ); return FALSE; } DrawPathToOutputDevice ( &BevelPath, PATHSHAPE_CIRCLE ); // Ensure that we're not writing to a NULL pointer. if ( mpShapeTail != NULL ) { // Variables for calculating the transparency. UINT32 Alpha = 0; UINT32 Colours = mpShapeTail->GetNumberColours (); // Sum all the alpha values for the path. I'm assuming that the bevel's // transparency has already been noted. for ( UINT32 i = 0; i < Colours; i++ ) { Alpha += mpShapeTail->GetColour ( i ).Alpha; } // Get the average colour for the bevel. Alpha /= Colours; // There are probably more elegant ways of doing this, but they would involve me // rewriting a lot of code for one special case. Instead, I'm going to overwrite // the existing fill colour with the bitmap. WORD BitmapID = GetBitmapID ( pBitmap, NULL, NULL, 255 ); DocRect Bounds = pBevel->GetBoundingRect (); // Remove the boundary lines from the bevel paths. mpShapeTail->RemoveLines (); // Some tweaks to the object inside the bevel. if ( mpShapeLast != NULL ) { mpShapeLast->RemoveLines (); } // Record the details of the fill. mpShapeTail->SetStartPoint ( Bounds.lo ); mpShapeTail->SetEndPoint ( DocCoord ( Bounds.hi.x, Bounds.lo.y ) ); mpShapeTail->SetEndPoint2 ( DocCoord ( Bounds.lo.x, Bounds.hi.y ) ); mpShapeTail->SetFill ( FLASH_CLIPPED_BITMAP ); // Record the size and ID number of the bitmap used. mpShapeTail->SetBitmapID ( BitmapID ); mpShapeTail->SetBitmapWidth ( pBitmap->GetWidth () ); mpShapeTail->SetBitmapHeight ( pBitmap->GetHeight () ); } // Clean up the bitmap created. if(pKernBitmap) { pKernBitmap->DestroyGreyscaleVersion(); delete pKernBitmap; } return TRUE; }

BOOL FlashRenderRegion::ExportBevelBegin (  NodeBevelBegin *  pBevel  )

Stub function to prevent NodeBevelBegin from rendering. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 14/12/99 Input: pBevel - A pointer to a NodeBevelBegin object. Returns: TRUE if success. See also: - Definition at line 739 of file swfrndr.cpp. { return TRUE; }

BOOL FlashRenderRegion::ExportButtonState (  FlashButtonRecord *  pButton  )  [protected]

This method is part of the button rollover support that is being added to the Flash export filter. Due to the way that the render region has been implemented, and the fact that I've been asked to do this after writing virtually all of the filter code, it's algorithm is a little strange. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 14/1/00 The Flash filter works by creating a series of linked lists containing a record of the objects to be exported during the pass through the rendering tree, which is a necessary first step to record reuseable resources such as bitmap images, and font definitions. This method is unique in that it goes back to previously created nodes and changes them by removing PlaceObject tags from this list. A more efficient way to do this would have been to pick up on whether a node was a part of a button before exporting. However, this would require rewriting a lot of code, and would probably end up being much more complex, so I'm willing to tolerate some eccentricity. Returns: TRUE if success, FALSE if an error is encountered. See also: - Definition at line 2169 of file swfrndr.cpp. { // Define local variables. FlashPlaceObject *pLast = mpPlaceTail; FlashSprite *pSprite = NULL; // If the function has been passed a NULL pointer, check whether a button name has been // set. If not, return from this function. if ( pButton == NULL ) { // If a name has been set, then this shape is part of a button array, so go and // process it. if ( ( mButtonState == NO_BUTTON ) && ( mButtonName.IsEmpty () ) ) { return FALSE; } } // Remove the object from the tail of the list. Rewind the PlaceObject tail pointer. mpPlaceTail = mpPlaceTail->GetLast (); // Catch NULL pointers to avoid access violations. if ( mpPlaceTail != NULL ) { mpPlaceTail->SetNext ( NULL ); } else { mpPlace = NULL; } // If no button exists at this point, get a match. pButton = MatchButton (); // Get the sprite record ID from the list. pSprite = MatchSprite ( pButton ); // Re-attatch the place object record to the sprite record. pSprite->SetTail ( pLast ); return TRUE; }

BOOL FlashRenderRegion::ExportCharacter (  TextChar *  pTheLetter  )

Adds the character into the two lists that maintain the strings to be exported to a Flash file. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 13/10/99 Input: TheLetter - A Unicode character, which is to be stored Returns: TRUE if success. See also: - Definition at line 408 of file swfrndr.cpp. { // Assume pointers (member variables) to: // - mpFont: A list of font styles being used by the program. // - mpText: A list of the text strings being used. // - mpPlace: A list of the place object tags. // Define local variables. TextLine *pTextLine = pTheLetter->FindParentLine (); Node *pTextStory = pTextLine->FindParent (); Node *pNode = pTextStory->FindFirstChild (); FlashFontRecord *pFont = NULL; DWORD FlashFontID = 0; INT32 CharCode = 0; FillGeometryAttribute *pFill = static_cast <FillGeometryAttribute*> ( GetCurrentAttribute ( ATTR_FILLGEOMETRY ) ); TranspFillAttribute *pTransp = static_cast <TranspFillAttribute*> ( GetCurrentAttribute ( ATTR_TRANSPFILLGEOMETRY ) ); StrokeColourAttribute *pStroke = static_cast <StrokeColourAttribute*> ( GetCurrentAttribute ( ATTR_STROKECOLOUR ) ); // If the text has a gradient or bitmap fill, or any transparency other than flat, // export it as a path. if ( !pFill->IsAFlatFill () || !pTransp->IsAFlatFill () || !pStroke->GetStartColour ()->IsTransparent () ) { // The fill is too complex to be exported as a straight Flash text character, so // export it as a path. return FALSE; } // Cycle through the list of children for the text node. If a NodePath is found, then // return FALSE. This will cause the letter to be exported as a shape rather than a // character, and so keep the alignment correct. This is here to export text on a curve, // which would otherwise not be correctly rendered. while ( pNode != NULL ) { if ( pNode->IsNodePath () || pNode->IsARegularShape () ) { // The text story contains a path, therefore it has to be exported as a set // of curves. return FALSE; } else { // Find the next node. pNode = pNode->FindNextNonHidden (); } } // Grab a pointer to the previous VTN in the TextStory. This is used for determining // whether or not to create a new FlashTextRecord for the successive characters. VisibleTextNode *pLastVTN = pTheLetter->FindPrevVTNInLine (); // Get the character to be exported from the TextChar record. WCHAR Glyph = pTheLetter->GetUnicodeValue (); // VisibleTextNodes are either renderable characters, carets, or end of line nodes. // I'm not interested in carets, so I'll skip these. if ( ( pLastVTN != NULL ) && ( pLastVTN->IsACaret () ) ) { pLastVTN = pLastVTN->FindPrevVTNInLine (); } // Step 1: Get the details of the font. // First the font's handle. WORD FontName = ( ( TxtFontTypefaceAttribute* ) GetCurrentAttribute ( ATTR_TXTFONTTYPEFACE ) )->HTypeface ; // Secondly, whether or not it's bold. BOOL IsBold = ( ( TxtBoldAttribute* ) GetCurrentAttribute ( ATTR_TXTBOLD ) )->BoldOn; // Thirdly, whether or not it's italic. BOOL IsItalic = ( ( TxtItalicAttribute* ) GetCurrentAttribute ( ATTR_TXTITALIC ) )->ItalicOn; // And finally, it's offset and relative size values. // TxtScriptAttribute *pScript = ( TxtScriptAttribute* ) GetCurrentAttribute ( ATTR_TXTSCRIPT ); // Flash doesn't seem to support fonts with obscure aspect ratios, so maybe set // that into the text matrix, along with rotates. // Step 2: Determine whether a new FlashTextRecord is needed. A new one is // required if either there isn't an existing FlashTextRecord to add the // characters to, or there's been a new line. Since the first character // to be stored will, by definition, be at the start of a new line, and // hence this is the only check that I need to make. if ( pLastVTN == NULL ) { // Step 2a: Create the new FlashTextRecord to contain the string. If none // exist at present, create it at mpText. Otherwise use add element. CreateTextRecord ( pTheLetter ); } // Step 2b: For each font, cycle through the list mpFontStyles, and // compare existing resources with the current font style. If a pre // -existing style matches, reuse this one, otherwise create a new // record. pFont = mpFont; // Spool through the list. while ( pFont != NULL ) { // Compare font names and styles. if ( ( pFont->GetTypeface () == FontName ) && ( pFont->GetIsBold () == IsBold ) && ( pFont->GetIsItalic () == IsItalic ) ) { // Break out of the while loop. break; } else { pFont = pFont->GetNext (); // Move on to the next item in the list. FlashFontID ++; // Increment ID number. } } // If pFont is NULL, no matching font styles have been stored, so create a // new record. if ( pFont == NULL ) { // If there are no existing font records, create one. if ( mpFont == NULL ) { mpFont = new FlashFontRecord; ASSERT ( mpFont != NULL ); pFont = mpFontTail = mpFont; } else { mpFontTail = mpFontTail->AddElement (); ASSERT ( mpFontTail != NULL ); pFont = mpFontTail; } // Record the necessary font metrics. There's no need to store FlashFontID // since that is implicit in the order of the elements in the list. (i.e. // the first item is #0, and the second is #1, etc.) pFont->SetTypeface ( FontName ); pFont->SetIsBold ( IsBold ); pFont->SetIsItalic ( IsItalic ); // Set the ID number for the font. pFont->SetFontID ( FlashPlaceObject::GetFontCount () ); FlashPlaceObject::IncFontCount (); } // And add the path. if ( pFont->AddGlyph ( Glyph, CharCode ) ) { Matrix FontMatrix; TxtFontSizeAttribute FlashFontSize ( FLASH_FONT_SIZE ); TxtFontSizeAttribute *pLastSize = ( TxtFontSizeAttribute* ) GetCurrentAttribute ( ATTR_TXTFONTSIZE ); TxtAspectRatioAttribute FlashAspect ( 1 ); TxtAspectRatioAttribute *pLastAspect = ( TxtAspectRatioAttribute* ) GetCurrentAttribute ( ATTR_TXTASPECTRATIO ); // Set the font size and aspect to the correct values to render the path. SetTxtFontSize ( &FlashFontSize, FALSE ); SetTxtAspectRatio ( &FlashAspect, FALSE ); // Add it to the record. pFont->AddPath ( CreateCharPath ( Glyph, &FontMatrix ), CharCode ); // Restore the current render region settings. RestoreTxtFontSize ( pLastSize, FALSE ); RestoreTxtAspectRatio ( pLastAspect, FALSE ); } // Step 3: Add the character to the end of the string, and the font style to the list // of characters used in that particular font. INT32 Index = mpTextTail->AddChar ( pTheLetter, CharCode ); // Fill in the font's characteristics: // Font size. // INT32 Offset = ( pScript->Offset ).GetRawLong (); // INT32 Ratio = ( pScript->Size ).GetRawLong (); MILLIPOINT Size = ( ( TxtFontSizeAttribute* ) GetCurrentAttribute ( ATTR_TXTFONTSIZE ) )->FontSize; // Set the font size. mpTextTail->SetSize ( Size, Index ); // And the ascent. mpTextTail->SetAscent ( pTheLetter->GetFontAscent () ); // Calculate the baseline of the font. // double dDiv = ( double ) Ratio * ( double ) FLASH_FIXED_ONE; // double dBase = ( double ) ( Size - pTheLetter->GetFontDescent () ) / dDiv; // And the offset. // double dOffset = Size * ( ( double ) Offset / ( double ) FLASH_FIXED_ONE ); // Use these to calculate the y offset value for the text. // double dYOff = dBase - dOffset - ( double ) pTheLetter->GetBaseLineShift (); // mpTextTail->SetBaseline ( ( INT32 ) dYOff, Index ); mpTextTail->SetOffset ( 0 , Index ); // Font colour. mpTextTail->SetColour ( pFill->GetStartColour (), pTransp->GetStartTransp (), Index ); // Typeface. Note: I'm using the FlashFontID numbers because these map the font // definitions (within the Flash file) onto the file's text definitions. mpTextTail->SetStyle ( ( WORD ) FlashFontID, Index ); // Step 4: Return TRUE. This allows me to use the standard error checking macros, which // will return FALSE if they hit a problem. return TRUE; }

BOOL FlashRenderRegion::ExportRenderableNode (  NodeRenderableInk *  pInk  )

Renders a stroked path to the file. Author: Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com> Date: 9/11/00 Input: pInk - The ink node to be exported. Returns: TRUE - The node contained a stroke, and was exported by this method. FALSE - Export using the default export code. See also: - Definition at line 836 of file swfrndr.cpp. { // Graeme (10/11/00) - I don't think that this is a particularly nice way to export a // stroked path to a Flash file. The EPS render region will export strokes automatically, // without any of this messing around, and as a result I suspect that the Flash render // region hasn't been properly initialised. // // There is, however, an advantage to doing it this way: By calling RetroSmoothMe on the // path, the overall file size required to store a given path is halved, which for is a // big advantage for the Flash file format, in which the file size is crucial. // Pointer to the stroke type attribute. AttrStrokeType *pStroke = NULL; /* NodeAttribute *pAttr = NULL; AttrBrushType *pBrush = NULL; // Find out if we have an applied brush node. pInk->FindAppliedAttribute ( CC_RUNTIME_CLASS ( AttrBrushType ), &pAttr ); // Cast it into a brush type attribute to avoid multiple casts in the following code. pBrush = static_cast <AttrBrushType*> ( pAttr ); if ( pBrush != NULL && pBrush->GetBrushHandle () != BrushHandle_NoBrush ) { SimpleBecomeA BecomeA ( BECOMEA_PASSBACK, CC_RUNTIME_CLASS ( NodePath ), NULL ); if ( pBrush->DoBecomeA ( &BecomeA, pInk ) ) { NodePath *pNodePath = Beco