-
Notifications
You must be signed in to change notification settings - Fork 0
/
Background.cs
177 lines (151 loc) · 5.14 KB
/
Background.cs
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
/*
* Background.java
* Transform
*
* Copyright (c) 2001-2010 Flagstone Software Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* * Neither the name of Flagstone Software Ltd. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.IO;
using com.flagstone.transform.coder;
using com.flagstone.transform.datatype;
namespace com.flagstone.transform
{
/// <summary>
/// Background sets the background colour displayed in every frame in the movie.
///
/// <para>
/// Although the colour is specified using an Color object the colour displayed
/// is completely opaque - the alpha channel information in the object is
/// ignored.
/// </para>
///
/// <para>
/// The background colour must be set before the first frame is displayed
/// otherwise the background colour defaults to white. This is typically the
/// first object in a coder. If more than one Background object is added to a
/// movie then only first one sets the background colour. Subsequent objects are
/// ignored.
/// </para>
/// </summary>
/// <seealso cref= Color </seealso>
public sealed class Background : MovieTag
{
/// <summary>
/// Format string used in toString() method. </summary>
private const string FORMAT = "Background: { color=%s}";
/// <summary>
/// The colour that will be displayed on the screen background. </summary>
private Color color;
/// <summary>
/// Creates and initialises a Background object using values encoded in the
/// Flash binary format.
/// </summary>
/// <param name="coder">
/// an SWFDecoder object that contains the encoded Flash data.
/// </param>
/// <param name="context">
/// a Context object used to manage the decoders for different
/// type of object and to pass information on how objects are
/// decoded.
/// </param>
/// <exception cref="IOException">
/// if an error occurs while decoding the data. </exception>
public Background(SWFDecoder coder, Context context)
{
int length = coder.readUnsignedShort() & Coder.LENGTH_FIELD;
if (length == Coder.IS_EXTENDED)
{
length = coder.readInt();
}
coder.mark();
color = new Color(coder, context);
coder.check(length);
coder.unmark();
}
/// <summary>
/// Creates a Background object with a the specified colour.
/// </summary>
/// <param name="aColor">
/// the colour for the background. Must not be null. </param>
public Background(Color aColor)
{
Color = aColor;
}
/// <summary>
/// Creates and initialises an Background object using the values
/// copied from another Background object.
/// </summary>
/// <param name="object">
/// a Background object from which the values will be
/// copied. </param>
public Background(Background @object)
{
color = @object.color;
}
/// <summary>
/// Get the colour for the movie background.
/// </summary>
/// <returns> the Color for the background of the Flash Player screen. </returns>
public Color Color
{
get => color;
set
{
if (value == null)
{
throw new ArgumentException();
}
color = value;
}
}
/// <summary>
/// {@inheritDoc} </summary>
public Background copy()
{
return new Background(this);
}
/// <summary>
/// {@inheritDoc} </summary>
public override string ToString()
{
return ObjectExtensions.FormatJava(FORMAT, color.ToString());
}
/// <summary>
/// {@inheritDoc} </summary>
public int prepareToEncode(Context context)
{
return 2 + Color.RGB;
}
/// <summary>
/// {@inheritDoc} </summary>
public void encode(SWFEncoder coder, Context context)
{
coder.writeShort((MovieTypes.SET_BACKGROUND_COLOR << Coder.LENGTH_FIELD_SIZE) | Color.RGB);
color.encode(coder, context);
}
}
}