1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
// must be first
#include <canvas/debug.hxx>
#include <canvas/verbosetrace.hxx>
#include <com/sun/star/drawing/XShape.hpp>
#include <com/sun/star/animations/XAnimate.hpp>
#include <com/sun/star/animations/AnimationNodeType.hpp>
#include <com/sun/star/presentation/EffectNodeType.hpp>
#include <com/sun/star/presentation/TextAnimationType.hpp>
#include <com/sun/star/animations/XAnimateSet.hpp>
#include <com/sun/star/animations/XIterateContainer.hpp>
#include <com/sun/star/presentation/ShapeAnimationSubType.hpp>
#include <com/sun/star/animations/XAnimateMotion.hpp>
#include <com/sun/star/animations/XAnimateColor.hpp>
#include <com/sun/star/animations/XAnimateTransform.hpp>
#include <com/sun/star/animations/AnimationTransformType.hpp>
#include <com/sun/star/animations/XTransitionFilter.hpp>
#include <com/sun/star/animations/XAudio.hpp>
#include <com/sun/star/presentation/ParagraphTarget.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <animations/animationnodehelper.hxx>
#include <basegfx/numeric/ftools.hxx>
#include "animationnodefactory.hxx"
#include "paralleltimecontainer.hxx"
#include "sequentialtimecontainer.hxx"
#include "propertyanimationnode.hxx"
#include "animationsetnode.hxx"
#include "animationpathmotionnode.hxx"
#include "animationcolornode.hxx"
#include "animationtransformnode.hxx"
#include "animationtransitionfilternode.hxx"
#include "animationaudionode.hxx"
#include "animationcommandnode.hxx"
#include "nodetools.hxx"
#include "tools.hxx"
#include <boost/bind.hpp>
using namespace ::com::sun::star;
namespace slideshow {
namespace internal {
namespace {
// forward declaration needed by NodeCreator
BaseNodeSharedPtr implCreateAnimationNode(
const uno::Reference< animations::XAnimationNode >& xNode,
const BaseContainerNodeSharedPtr& rParent,
const NodeContext& rContext );
class NodeCreator
{
public:
NodeCreator( BaseContainerNodeSharedPtr& rParent,
const NodeContext& rContext )
: mrParent( rParent ), mrContext( rContext ) {}
void operator()(
const uno::Reference< animations::XAnimationNode >& xChildNode ) const
{
createChild( xChildNode, mrContext );
}
protected:
void createChild(
const uno::Reference< animations::XAnimationNode >& xChildNode,
const NodeContext& rContext ) const
{
BaseNodeSharedPtr pChild( implCreateAnimationNode( xChildNode,
mrParent,
rContext ) );
OSL_ENSURE( pChild,
"NodeCreator::operator(): child creation failed" );
// TODO(Q1): This yields circular references, which, it seems, is
// unavoidable here
if( pChild )
mrParent->appendChildNode( pChild );
}
BaseContainerNodeSharedPtr& mrParent;
const NodeContext& mrContext;
};
/** Same as NodeCreator, only that NodeContext's
SubsetShape is cloned for every child node.
This is used for iterated animation node generation
*/
class CloningNodeCreator : private NodeCreator
{
public:
CloningNodeCreator( BaseContainerNodeSharedPtr& rParent,
const NodeContext& rContext )
: NodeCreator( rParent, rContext ) {}
void operator()(
const uno::Reference< animations::XAnimationNode >& xChildNode ) const
{
NodeContext aContext( mrContext );
// TODO(Q1): There's a catch here. If you clone a
// subset whose actual subsetting has already been
// realized (i.e. if enableSubsetShape() has been
// called already), and the original of your clone
// goes out of scope, then your subset will be
// gone (SubsettableShapeManager::revokeSubset() be
// called). As of now, this behaviour is not
// triggered here (we either clone, XOR we enable
// subset initially), but one might consider
// reworking DrawShape/ShapeSubset to avoid this.
// clone ShapeSubset, since each node needs their
// own version of the ShapeSubset (otherwise,
// e.g. activity counting does not work - subset
// would be removed after first animation node
// disables it).
//
// NOTE: this is only a problem for animation
// nodes that explicitly call
// disableSubsetShape(). Independent shape subsets
// (like those created for ParagraphTargets)
// solely rely on the ShapeSubset destructor to
// normalize things, which does the right thing
// here: the subset is only removed after _the
// last_ animation node releases the shared ptr.
aContext.mpMasterShapeSubset.reset(
new ShapeSubset( *aContext.mpMasterShapeSubset ) );
createChild( xChildNode, aContext );
}
};
/** Create animation nodes for text iterations
This method clones the animation nodes below xIterNode
for every iterated shape entity.
*/
bool implCreateIteratedNodes(
const uno::Reference< animations::XIterateContainer >& xIterNode,
BaseContainerNodeSharedPtr& rParent,
const NodeContext& rContext )
{
ENSURE_OR_THROW( xIterNode.is(),
"implCreateIteratedNodes(): Invalid node" );
const double nIntervalTimeout( xIterNode->getIterateInterval() );
// valid iterate interval? We're ruling out monstrous
// values here, to avoid pseudo 'hangs' in the
// presentation
if( nIntervalTimeout < 0.0 ||
nIntervalTimeout > 1000.0 )
{
return false; // not an active iteration
}
if( ::basegfx::fTools::equalZero( nIntervalTimeout ) )
OSL_TRACE( "implCreateIteratedNodes(): "
"iterate interval close to zero, there's "
"no point in defining such an effect "
"(visually equivalent to whole-shape effect)" );
// Determine target shape (or subset)
// ==================================
// TODO(E1): I'm not too sure what to expect here...
ENSURE_OR_RETURN_FALSE(
xIterNode->getTarget().hasValue(),
"implCreateIteratedNodes(): no target on ITERATE node" );
uno::Reference< drawing::XShape > xTargetShape( xIterNode->getTarget(),
uno::UNO_QUERY );
presentation::ParagraphTarget aTarget;
sal_Int16 nSubItem( xIterNode->getSubItem() );
bool bParagraphTarget( false );
if( !xTargetShape.is() )
{
// no shape provided. Maybe a ParagraphTarget?
if( !(xIterNode->getTarget() >>= aTarget) )
ENSURE_OR_RETURN_FALSE(
false,
"implCreateIteratedNodes(): could not extract any "
"target information" );
xTargetShape = aTarget.Shape;
ENSURE_OR_RETURN_FALSE(
xTargetShape.is(),
"implCreateIteratedNodes(): invalid shape in ParagraphTarget" );
// we've a paragraph target to iterate over, thus,
// the whole animation container refers only to
// the text
nSubItem = presentation::ShapeAnimationSubType::ONLY_TEXT;
bParagraphTarget = true;
}
// Lookup shape, and fill NodeContext
// ==================================
AttributableShapeSharedPtr pTargetShape(
lookupAttributableShape( rContext.maContext.mpSubsettableShapeManager,
xTargetShape ) );
const DocTreeNodeSupplier& rTreeNodeSupplier(
pTargetShape->getTreeNodeSupplier() );
ShapeSubsetSharedPtr pTargetSubset;
NodeContext aContext( rContext );
// paragraph targets already need a subset as the
// master shape (they're representing only a single
// paragraph)
if( bParagraphTarget )
{
ENSURE_OR_RETURN_FALSE(
aTarget.Paragraph >= 0 &&
rTreeNodeSupplier.getNumberOfTreeNodes(
DocTreeNode::NODETYPE_LOGICAL_PARAGRAPH ) > aTarget.Paragraph,
"implCreateIteratedNodes(): paragraph index out of range" );
pTargetSubset.reset(
new ShapeSubset(
pTargetShape,
// retrieve index aTarget.Paragraph of
// type PARAGRAPH from this shape
rTreeNodeSupplier.getTreeNode(
aTarget.Paragraph,
DocTreeNode::NODETYPE_LOGICAL_PARAGRAPH ),
rContext.maContext.mpSubsettableShapeManager ) );
// iterate target is not the whole shape, but only
// the selected paragraph - subset _must_ be
// independent, to be able to affect visibility
// independent of master shape
aContext.mbIsIndependentSubset = true;
// already enable parent subset right here, to
// make potentially generated subsets subtract
// their content from the parent subset (and not
// the original shape). Otherwise, already
// subsetted parents (e.g. paragraphs) would not
// have their characters removed, when the child
// iterations start.
// Furthermore, the setup of initial shape
// attributes of course needs the subset shape
// generated, to apply e.g. visibility changes.
pTargetSubset->enableSubsetShape();
}
else
{
pTargetSubset.reset(
new ShapeSubset( pTargetShape,
rContext.maContext.mpSubsettableShapeManager ));
}
aContext.mpMasterShapeSubset = pTargetSubset;
uno::Reference< animations::XAnimationNode > xNode( xIterNode,
uno::UNO_QUERY_THROW );
// Generate subsets
// ================
if( bParagraphTarget ||
nSubItem != presentation::ShapeAnimationSubType::ONLY_TEXT )
{
// prepend with animations for
// full Shape (will be subtracted
// from the subset parts within
// the Shape::createSubset()
// method). For ONLY_TEXT effects,
// we skip this part, to animate
// only the text.
//
// OR
//
// prepend with subset animation for full
// _paragraph_, from which the individual
// paragraph subsets are subtracted. Note that the
// subitem is superfluous here, we always assume
// ONLY_TEXT, if a paragraph is referenced as the
// master of an iteration effect.
NodeCreator aCreator( rParent, aContext );
if( !::anim::for_each_childNode( xNode,
aCreator ) )
{
ENSURE_OR_RETURN_FALSE(
false,
"implCreateIteratedNodes(): iterated child node creation failed" );
}
}
// TODO(F2): This does not do the correct
// thing. Having nSubItem be set to ONLY_BACKGROUND
// should result in the text staying unanimated in the
// foreground, while the shape moves in the background
// (this behaviour is perfectly possible with the
// slideshow engine, only that the text won't be
// currently visible, because animations are always in
// the foreground)
if( nSubItem != presentation::ShapeAnimationSubType::ONLY_BACKGROUND )
{
// determine type of subitem iteration (logical
// text unit to animate)
DocTreeNode::NodeType eIterateNodeType(
DocTreeNode::NODETYPE_LOGICAL_CHARACTER_CELL );
switch( xIterNode->getIterateType() )
{
case presentation::TextAnimationType::BY_PARAGRAPH:
eIterateNodeType = DocTreeNode::NODETYPE_LOGICAL_PARAGRAPH;
break;
case presentation::TextAnimationType::BY_WORD:
eIterateNodeType = DocTreeNode::NODETYPE_LOGICAL_WORD;
break;
case presentation::TextAnimationType::BY_LETTER:
eIterateNodeType = DocTreeNode::NODETYPE_LOGICAL_CHARACTER_CELL;
break;
default:
ENSURE_OR_THROW(
false, "implCreateIteratedNodes(): "
"Unexpected IterateType on XIterateContainer");
break;
}
if( bParagraphTarget &&
eIterateNodeType != DocTreeNode::NODETYPE_LOGICAL_WORD &&
eIterateNodeType != DocTreeNode::NODETYPE_LOGICAL_CHARACTER_CELL )
{
// will not animate the whole paragraph, when
// only the paragraph is animated at all.
OSL_FAIL( "implCreateIteratedNodes(): Ignoring paragraph iteration for paragraph master" );
}
else
{
// setup iteration parameters
// --------------------------
// iterate target is the whole shape (or the
// whole parent subshape), thus, can save
// loads of subset shapes by generating them
// only when the effects become active -
// before and after the effect active
// duration, all attributes are shared by
// master shape and subset (since the iterated
// effects are all the same).
aContext.mbIsIndependentSubset = false;
// determine number of nodes for given subitem
// type
sal_Int32 nTreeNodes( 0 );
if( bParagraphTarget )
{
// create the iterated subset _relative_ to
// the given paragraph index (i.e. animate the
// given subset type, but only when it's part
// of the given paragraph)
nTreeNodes = rTreeNodeSupplier.getNumberOfSubsetTreeNodes(
pTargetSubset->getSubset(),
eIterateNodeType );
}
else
{
// generate normal subset
nTreeNodes = rTreeNodeSupplier.getNumberOfTreeNodes(
eIterateNodeType );
}
// iterate node, generate copies of the children for each subset
// -------------------------------------------------------------
// NodeContext::mnStartDelay contains additional node delay.
// This will make the duplicated nodes for each iteration start
// increasingly later.
aContext.mnStartDelay = nIntervalTimeout;
for( sal_Int32 i=0; i<nTreeNodes; ++i )
{
// create subset with the corresponding tree nodes
if( bParagraphTarget )
{
// create subsets relative to paragraph subset
aContext.mpMasterShapeSubset.reset(
new ShapeSubset(
pTargetSubset,
rTreeNodeSupplier.getSubsetTreeNode(
pTargetSubset->getSubset(),
i,
eIterateNodeType ) ) );
}
else
{
// create subsets from main shape
aContext.mpMasterShapeSubset.reset(
new ShapeSubset( pTargetSubset,
rTreeNodeSupplier.getTreeNode(
i,
eIterateNodeType ) ) );
}
CloningNodeCreator aCreator( rParent, aContext );
if( !::anim::for_each_childNode( xNode,
aCreator ) )
{
ENSURE_OR_RETURN_FALSE(
false, "implCreateIteratedNodes(): "
"iterated child node creation failed" );
}
aContext.mnStartDelay += nIntervalTimeout;
}
}
}
// done with iterate child generation
return true;
}
BaseNodeSharedPtr implCreateAnimationNode(
const uno::Reference< animations::XAnimationNode >& xNode,
const BaseContainerNodeSharedPtr& rParent,
const NodeContext& rContext )
{
ENSURE_OR_THROW( xNode.is(),
"implCreateAnimationNode(): invalid XAnimationNode" );
BaseNodeSharedPtr pCreatedNode;
BaseContainerNodeSharedPtr pCreatedContainer;
// create the internal node, corresponding to xNode
switch( xNode->getType() )
{
case animations::AnimationNodeType::CUSTOM:
OSL_FAIL( "implCreateAnimationNode(): "
"CUSTOM not yet implemented" );
return pCreatedNode;
case animations::AnimationNodeType::PAR:
pCreatedNode = pCreatedContainer = BaseContainerNodeSharedPtr(
new ParallelTimeContainer( xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::ITERATE:
// map iterate container to ParallelTimeContainer.
// the iterating functionality is to be found
// below, (see method implCreateIteratedNodes)
pCreatedNode = pCreatedContainer = BaseContainerNodeSharedPtr(
new ParallelTimeContainer( xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::SEQ:
pCreatedNode = pCreatedContainer = BaseContainerNodeSharedPtr(
new SequentialTimeContainer( xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::ANIMATE:
pCreatedNode.reset( new PropertyAnimationNode(
xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::SET:
pCreatedNode.reset( new AnimationSetNode(
xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::ANIMATEMOTION:
pCreatedNode.reset( new AnimationPathMotionNode(
xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::ANIMATECOLOR:
pCreatedNode.reset( new AnimationColorNode(
xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::ANIMATETRANSFORM:
pCreatedNode.reset( new AnimationTransformNode(
xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::TRANSITIONFILTER:
pCreatedNode.reset( new AnimationTransitionFilterNode(
xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::AUDIO:
pCreatedNode.reset( new AnimationAudioNode(
xNode, rParent, rContext ) );
break;
case animations::AnimationNodeType::COMMAND:
pCreatedNode.reset( new AnimationCommandNode(
xNode, rParent, rContext ) );
break;
default:
OSL_FAIL( "implCreateAnimationNode(): "
"invalid AnimationNodeType" );
return pCreatedNode;
}
// TODO(Q1): This yields circular references, which, it seems, is
// unavoidable here
// HACK: node objects need shared_ptr to themselves,
// which we pass them here.
pCreatedNode->setSelf( pCreatedNode );
// if we've got a container node object, recursively add
// its children
if( pCreatedContainer )
{
uno::Reference< animations::XIterateContainer > xIterNode(
xNode, uno::UNO_QUERY );
// when this node is an XIterateContainer with
// active iterations, this method will generate
// the appropriate children
if( xIterNode.is() )
{
// note that implCreateIteratedNodes() might
// choose not to generate any child nodes
// (e.g. when the iterate timeout is outside
// sensible limits). Then, no child nodes are
// generated at all, since typically, child
// node attribute are incomplete for iteration
// children.
implCreateIteratedNodes( xIterNode,
pCreatedContainer,
rContext );
}
else
{
// no iterate subset node, just plain child generation now
NodeCreator aCreator( pCreatedContainer, rContext );
if( !::anim::for_each_childNode( xNode, aCreator ) )
{
OSL_FAIL( "implCreateAnimationNode(): "
"child node creation failed" );
return BaseNodeSharedPtr();
}
}
}
return pCreatedNode;
}
} // anon namespace
AnimationNodeSharedPtr AnimationNodeFactory::createAnimationNode(
const uno::Reference< animations::XAnimationNode >& xNode,
const ::basegfx::B2DVector& rSlideSize,
const SlideShowContext& rContext )
{
ENSURE_OR_THROW(
xNode.is(),
"AnimationNodeFactory::createAnimationNode(): invalid XAnimationNode" );
return BaseNodeSharedPtr( implCreateAnimationNode(
xNode,
BaseContainerNodeSharedPtr(), // no parent
NodeContext( rContext,
rSlideSize )));
}
#if defined(VERBOSE) && defined(DBG_UTIL)
void AnimationNodeFactory::showTree( AnimationNodeSharedPtr& pRootNode )
{
if( pRootNode )
DEBUG_NODES_SHOWTREE( boost::dynamic_pointer_cast<BaseContainerNode>(
pRootNode).get() );
}
#endif
} // namespace internal
} // namespace slideshow
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|