BrawlLib.SSBB.ResourceNodes.SCN0CameraNode Class Reference

Inheritance diagram for BrawlLib.SSBB.ResourceNodes.SCN0CameraNode:

Public Member Functions
override bool	OnInitialize ()
override int	OnCalculateSize (bool force)
override void	OnRebuild (VoidPtr address, int length, bool force)
void	SetCamera (ModelPanelViewport v, float frame, bool retainAspect)
void	GetModelViewMatrix (float frame, out Matrix mtx, out Matrix inverse)
	mtx is from camera to world space (a point in camera space) inverse is from world to camera space (a point in the world) More...
Vector3	GetStart (float frame)
Vector3	GetEnd (float frame)
CameraAnimationFrame	GetAnimFrame (float index)
float	GetFrameValue (CameraKeyframeMode keyFrameMode, float index)
Vector3	GetRotate (float frame)
Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.SCN0EntryNode
override bool	OnInitialize ()
override void	OnRebuild (VoidPtr address, int length, bool force)
IColorSource	FindColorMatch (bool constant, int frameCount, int id)
int	WriteColors (ref int flags, int bit, RGBAPixel solidColor, List< RGBAPixel > colors, bool constant, int frameCount, VoidPtr valueAddr, ref VoidPtr thisMatchAddr, VoidPtr thatMatchAddr, RGBAPixel *dataAddr)
void	DecodeKeyframes (KeyframeArray kf, VoidPtr dataAddr, int flags, int fixedBit)
	Reads keyframes from an address and sets them in the keyframe array provided. More...
Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
void	OnRenamed ()
List< ResourceNode >	GetChildrenRecursive ()
	Used primarily to get bone lists. Kept for all resource nodes for utility. More...
virtual void	SignalPropertyChange ()
virtual void	Dispose ()
void	SelectChildAtIndex (int index)
void	UpdateProperties ()
void	UpdateCurrentControl ()
virtual bool	MoveUp ()
virtual bool	MoveDown ()
virtual void	OnMoved ()
virtual void	DoMoveDown ()
virtual void	DoMoveDown (bool select)
virtual void	DoMoveUp ()
virtual void	DoMoveUp (bool select)
virtual bool	AddUp ()
virtual bool	AddDown ()
virtual bool	ToParent ()
void	Populate (int levels=-1)
virtual void	OnPopulate ()
void	Initialize (ResourceNode parent, FileMap source)
void	Initialize (ResourceNode parent, VoidPtr address, int length)
void	Initialize (ResourceNode parent, DataSource origSource)
virtual void	Initialize (ResourceNode parent, DataSource origSource, DataSource uncompSource)
virtual bool	OnInitialize ()
virtual void	Restore ()
virtual void	Remove ()
virtual void	RemoveChild (ResourceNode child)
virtual void	AddChild (ResourceNode child)
virtual void	AddChild (ResourceNode child, bool change)
virtual void	InsertChild (ResourceNode child, int index)
virtual void	InsertChild (ResourceNode child, bool change, int index)
void	SetSizeInternal (int size)
virtual void	Replace (string fileName)
virtual void	Replace (ResourceNode node)
virtual void	Replace (string fileName, FileMapProtect prot, FileOptions options)
virtual void	ReplaceRaw (VoidPtr address, int length)
virtual void	ReplaceRaw (FileMap map)
virtual void	Export (string outPath)
void	Export (FileStream outStream)
virtual void	ExportUncompressed (string outPath)
void	ExportUncompressed (FileStream outStream)
virtual void	Rebuild ()
virtual void	Rebuild (bool force)
virtual void	Rebuild (VoidPtr address, int length, bool force)
virtual void	OnRebuild (VoidPtr address, int length, bool force)
virtual int	CalculateSize (bool force)
virtual int	OnCalculateSize (bool force)
void	Merge ()
void	Merge (bool forceBuild)
ResourceNode	FindChildByType (string path, bool searchChildren, params ResourceType[] types)
ResourceNode	FindChildByType (string path, bool searchChildren, StringComparison compare, params ResourceType[] types)
ResourceNode	FindChild (string path)
ResourceNode	FindChild (string path, bool searchChildren)
ResourceNode	FindChild (string path, StringComparison compare)
ResourceNode	FindChild (string path, bool searchChildren, StringComparison compare)
ResourceNode[]	FindChildrenByClassType (string path, Type type)
ResourceNode[]	FindChildrenByType (string path, ResourceType type)
ResourceNode[]	FindChildrenByTypeInGroup (string path, ResourceType type, byte group)
ResourceNode[]	FindChildrenByName (string name)
unsafe string	FindName (string name)
ResourceNode	FindEmbeddedIndex (int index)
virtual unsafe byte[]	MD5 ()
	Find the MD5 checksum of this node's data. If this node doesn't have any data (BRESGroupNode, for example), this method will return null. More...
string	MD5Str ()
	Get the result of the MD5() function as a string of hexadecimal digits. If MD5() returns null, this method will return an empty string. More...
ResourceNode	PrevSibling ()
ResourceNode	NextSibling ()
override string	ToString ()
virtual void	SortChildren ()

Public Attributes
SCN0CameraType	_type = SCN0CameraType.Aim
ProjectionType	_projType
SCN0CameraFlags	_flags1 = (SCN0CameraFlags) 0xFFFE
ushort	_flags2 = 1
SCN0CameraFlags[]	Ordered
Public Attributes inherited from BrawlLib.SSBB.ResourceNodes.SCN0EntryNode
int[]	_dataLengths = {0, 0, 0}
VoidPtr[]	_dataAddrs = new VoidPtr[3]
Public Attributes inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
Form	_mainForm
string	_name
string	_origPath
ResourceNode	_parent
List< ResourceNode >	_children = new List<ResourceNode>()
int	_calcSize
EventHandler	UpdateControl
MoveEventHandler	MovedDown
ResourceEventHandler	Renamed
ResourceEventHandler	PropertyChanged
ResourceEventHandler	Replaced
ResourceEventHandler	Restored
ResourceChildEventHandler	ChildRemoved
bool	_isPopulating
bool	_replaced

Static Public Attributes
static bool	_generateTangents = true

Properties
override ResourceType	ResourceFileType [get]
UserDataCollection	UserEntries [get, set]
int	FrameCount [get]
SCN0CameraType	Type [get, set]
ProjectionType	ProjectionType [get, set]
KeyframeArray	PosX [get]
KeyframeArray	PosY [get]
KeyframeArray	PosZ [get]
KeyframeArray	Aspect [get]
KeyframeArray	NearZ [get]
KeyframeArray	FarZ [get]
KeyframeArray	RotX [get]
KeyframeArray	RotY [get]
KeyframeArray	RotZ [get]
KeyframeArray	AimX [get]
KeyframeArray	AimY [get]
KeyframeArray	AimZ [get]
KeyframeArray	Twist [get]
KeyframeArray	FovY [get]
KeyframeArray	Height [get]
KeyframeCollection	Keyframes [get]
KeyframeArray[]	KeyArrays [get]
Properties inherited from BrawlLib.SSBB.ResourceNodes.SCN0EntryNode
override bool	AllowNullNames [get]
SCN0Node	Scene [get]
int	NodeIndex [get]
int	RealIndex [get]
Properties inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
string	FilePath [get]
string	FileName [get]
string	DirectoryName [get]
ResourceNode	RootNode [get]
DataSource	OriginalSource [get]
DataSource	UncompressedSource [get]
DataSource	WorkingSource [get]
DataSource	WorkingUncompressed [get]
virtual bool	HasChildren [get]
virtual ResourceType	ResourceFileType [get]
string	NodeType [get]
virtual string	TreePathAbsolute [get]
virtual string	TreePath [get]
virtual int	Level [get]
virtual int	MaxNameLength [get]
virtual bool	AllowDuplicateNames [get]
virtual bool	AllowNullNames [get]
virtual string	Name [get, set]
ResourceNode	Parent [get, set]
List< ResourceNode >	Children [get]
int	Index [get]
int	HexIndex [get]
bool	IsCompressed [get]
bool	HasChanged [get, set]
bool	IsBranch [get]
bool	HasMerged [get]
virtual bool	AllowSaving [get, set]
virtual bool	IsDirty [get, set]
virtual uint	UncompressedSize [get]
virtual Type[]	AllowedChildTypes [get]
virtual string	Compression [get, set]
virtual bool	RetainChildrenOnReplace [get]
virtual bool	supportsCompression [get]
static MD5CryptoServiceProvider	MD5Provider [get]
Properties inherited from BrawlLib.Wii.Animations.IKeyframeSource
int	FrameCount [get]
KeyframeArray[]	KeyArrays [get]

Additional Inherited Members
Static Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.SCN0EntryNode
static void	DecodeKeyframes (KeyframeArray kf, VoidPtr dataAddr)
	Reads keyframes at an address, starting with the keyframe array header. More...
static int	EncodeKeyframes (KeyframeArray kf, VoidPtr dataAddr, VoidPtr offset, ref int flags, int fixedBit)
static int	EncodeKeyframes (KeyframeArray kf, VoidPtr dataAddr, VoidPtr offset)
static int	EncodeKeyframes (KeyframeArray kf, VoidPtr dataAddr)
Static Public Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
static ResourceNode[]	FindAllSubNodes (ResourceNode root)
static ResourceNode	FindNode (ResourceNode root, string path, bool searchChildren, StringComparison compare)
Protected Member Functions inherited from BrawlLib.SSBB.ResourceNodes.SCN0EntryNode
void	ReadColors (uint flags, uint bit, ref RGBAPixel solidColor, ref List< RGBAPixel > colors, int frameCount, VoidPtr address, ref bool constant, ref int numEntries)
void	CalcKeyLen (KeyframeArray keyframes)
Protected Member Functions inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
void	ForceReplacedEvent ()
virtual void	MergeInternal ()
Events inherited from BrawlLib.SSBB.ResourceNodes.ResourceNode
SelectEventHandler	SelectChild
EventHandler	UpdateProps
MoveEventHandler	MovedUp
ResourceEventHandler	Disposing
ResourceChildEventHandler	ChildAdded
ResourceChildInsertEventHandler	ChildInserted

Member Function Documentation

GetAnimFrame()

CameraAnimationFrame BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.GetAnimFrame ( float  index )

inline

        {
            CameraAnimationFrame frame;
            float* dPtr = (float*) &frame;
            for (int x = 0; x < 15; x++)
            {
                KeyframeArray a = Keyframes[x];
                *dPtr++ = a.GetFrameValue(index);
                frame.SetBools(x, a.GetKeyframe((int) index) != null);
                frame.Index = index;
            }
 
            return frame;
        }

GetEnd()

Vector3 BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.GetEnd ( float  frame )

inline

        {
            return new Vector3(
                AimX.GetFrameValue(frame),
                AimY.GetFrameValue(frame),
                AimZ.GetFrameValue(frame));
        }

GetFrameValue()

float BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.GetFrameValue ( CameraKeyframeMode  keyFrameMode, float  index  )

inline

        {
            return Keyframes[(int) keyFrameMode].GetFrameValue(index);
        }

GetModelViewMatrix()

void BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.GetModelViewMatrix ( float  frame, out Matrix  mtx, out Matrix  inverse  )

inline

mtx is from camera to world space (a point in camera space) inverse is from world to camera space (a point in the world)

        {
            CameraAnimationFrame f = GetAnimFrame(frame);
            Vector3 r = f.GetRotation(Type);
            Vector3 t = f.Pos;
 
            mtx = Matrix.ReverseTransformMatrix(new Vector3(1.0f), r, t);
            inverse = Matrix.TransformMatrix(new Vector3(1.0f), r, t);
        }

GetRotate()

Vector3 BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.GetRotate ( float  frame )

inline

        {
            return new Vector3(RotX.GetFrameValue(frame), RotY.GetFrameValue(frame), RotZ.GetFrameValue(frame));
        }

GetStart()

Vector3 BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.GetStart ( float  frame )

inline

        {
            return new Vector3(
                PosX.GetFrameValue(frame),
                PosY.GetFrameValue(frame),
                PosZ.GetFrameValue(frame));
        }

OnCalculateSize()

override int BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.OnCalculateSize ( bool  force )

inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

        {
            //Reset data lengths
            for (int i = 0; i < 3; i++)
            {
                _dataLengths[i] = 0;
            }
 
            int size = SCN0Camera.Size;
 
            if (_name != "<null>")
            {
                //Get the total data size of all keyframes
                for (int i = 0; i < 15; i++)
                {
                    CalcKeyLen(Keyframes[i]);
                }
 
                //Add the size of the user entries
                size += _userEntries.GetSize();
            }
 
            return size;
        }

OnInitialize()

override bool BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.OnInitialize ( )

inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

        {
            //Read common header
            base.OnInitialize();
 
            if (_name == "<null>")
            {
                return false;
            }
 
            //Read header data
            _flags1 = (SCN0CameraFlags) (ushort) Data->_flags1;
            _flags2 = Data->_flags2;
            _type = (SCN0CameraType) (_flags2 & 1);
            _projType = (ProjectionType) (int) Data->_projectionType;
 
            //Read user data
            (_userEntries = new UserDataCollection()).Read(Data->UserData, WorkingUncompressed);
 
            return false;
        }

OnRebuild()

override void BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.OnRebuild ( VoidPtr  address, int  length, bool  force  )

inlinevirtual

Reimplemented from BrawlLib.SSBB.ResourceNodes.ResourceNode.

        {
            base.OnRebuild(address, length, force);
 
            if (_name == "<null>")
            {
                return;
            }
 
            SCN0Camera* header = (SCN0Camera*) address;
 
            header->_projectionType = (int) _projType;
            header->_flags2 = (ushort) (2 + (int) _type);
            header->_userDataOffset = 0;
 
            int newFlags1 = 0;
 
            for (int i = 0; i < 15; i++)
            {
                _dataAddrs[0] += EncodeKeyframes(
                    Keyframes[i],
                    _dataAddrs[0],
                    header->_position._x.Address + i * 4,
                    ref newFlags1,
                    (int) Ordered[i]);
            }
 
            header->_flags1 = (ushort) newFlags1;
 
            if (_userEntries.Count > 0)
            {
                _userEntries.Write(header->UserData = (VoidPtr) header + SCN0Camera.Size);
            }
        }

SetCamera()

void BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.SetCamera ( ModelPanelViewport  v, float  frame, bool  retainAspect  )

inline

        {
            ViewportProjection proj = (ViewportProjection) (int) ProjectionType;
            if (v.ViewType != proj)
            {
                v.SetProjectionType(proj);
            }
 
            GLCamera cam = v.Camera;
            CameraAnimationFrame f = GetAnimFrame(frame);
            cam.Reset();
            cam.Translate(f.Pos);
 
            Vector3 rotate = f.GetRotation(Type);
            cam.Rotate(rotate);
 
            float aspect = retainAspect ? cam.Aspect : f.Aspect;
            cam.SetProjectionParams(aspect, f.FovY, f.FarZ, f.NearZ);
        }

Member Data Documentation

_flags1

SCN0CameraFlags BrawlLib.SSBB.ResourceNodes.SCN0CameraNode._flags1 = (SCN0CameraFlags) 0xFFFE

_flags2

ushort BrawlLib.SSBB.ResourceNodes.SCN0CameraNode._flags2 = 1

_generateTangents

bool BrawlLib.SSBB.ResourceNodes.SCN0CameraNode._generateTangents = true

static

_projType

ProjectionType BrawlLib.SSBB.ResourceNodes.SCN0CameraNode._projType

_type

SCN0CameraType BrawlLib.SSBB.ResourceNodes.SCN0CameraNode._type = SCN0CameraType.Aim

Ordered

SCN0CameraFlags [] BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.Ordered

Initial value:

= new SCN0CameraFlags[]
        {
            SCN0CameraFlags.PosXConstant,
            SCN0CameraFlags.PosYConstant,
            SCN0CameraFlags.PosZConstant,
            SCN0CameraFlags.AspectConstant,
            SCN0CameraFlags.NearConstant,
            SCN0CameraFlags.FarConstant,
            SCN0CameraFlags.RotXConstant,
            SCN0CameraFlags.RotYConstant,
            SCN0CameraFlags.RotZConstant,
            SCN0CameraFlags.AimXConstant,
            SCN0CameraFlags.AimYConstant,
            SCN0CameraFlags.AimZConstant,
            SCN0CameraFlags.TwistConstant,
            SCN0CameraFlags.PerspFovYConstant,
            SCN0CameraFlags.OrthoHeightConstant
        }

Property Documentation

AimX

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.AimX

get

AimY

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.AimY

get

AimZ

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.AimZ

get

Aspect

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.Aspect

get

FarZ

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.FarZ

get

FovY

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.FovY

get

FrameCount

int BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.FrameCount

get

Implements BrawlLib.Wii.Animations.IKeyframeSource.

Height

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.Height

get

KeyArrays

KeyframeArray [] BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.KeyArrays

get

Implements BrawlLib.Wii.Animations.IKeyframeSource.

Keyframes

KeyframeCollection BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.Keyframes

get

        {
            get
            {
                if (_keyframes == null)
                {
                    _keyframes =
                        new KeyframeCollection(15, Scene == null ? 1 : Scene.FrameCount + (Scene.Loop ? 1 : 0));
                    if (Data != null && Name != "<null>")
                    {
                        for (int i = 0; i < 15; i++)
                        {
                            DecodeKeyframes(
                                Keyframes[i],
                                Data->_position._x.Address + i * 4,
                                (int) _flags1,
                                (int) Ordered[i]);
                        }
                    }
                }
 
                return _keyframes;
            }
        }

NearZ

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.NearZ

get

PosX

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.PosX

get

PosY

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.PosY

get

PosZ

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.PosZ

get

ProjectionType

ProjectionType BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.ProjectionType

getset

        {
            get => _projType;
            set
            {
                _projType = value;
                SignalPropertyChange();
            }
        }

ResourceFileType

override ResourceType BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.ResourceFileType

get

RotX

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.RotX

get

RotY

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.RotY

get

RotZ

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.RotZ

get

Twist

KeyframeArray BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.Twist

get

Type

SCN0CameraType BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.Type

getset

        {
            get => _type;
            set
            {
                _type = value;
                SignalPropertyChange();
            }
        }

UserEntries

UserDataCollection BrawlLib.SSBB.ResourceNodes.SCN0CameraNode.UserEntries

getset

        {
            get => _userEntries;
            set
            {
                _userEntries = value;
                SignalPropertyChange();
            }
        }

---

The documentation for this class was generated from the following file:

• BrawlLib/SSBB/ResourceNodes/SCN0/SCN0CameraNode.cs