wavelength 1.0.0
Loading...
Searching...
No Matches
PreviewPacket Class Reference

Packet that reports the remix editor's preview of a section started or stopped. More...

#include <previewpacket.h>

Inheritance diagram for PreviewPacket:
Collaboration diagram for PreviewPacket:

Public Member Functions

 ~PreviewPacket () override=default
 Destroy the object.
 PreviewPacket ()
 Construct a packet with no section.
void * operator new (size_t nSize)
 Allocate a packet, billed to the class name.
void operator delete (void *pBlock)
 Release a packet.
Message * Clone () override
 Produce a heap copy of this packet.
int Type () override
 Report this packet's registered identity.
const char * GetName () const override
 Report this packet's class name.
void saveGuts (BinStream &stream) const override
 Write the fields packed into one word.
void restoreGuts (BinStream &stream) override
 Read the word saveGuts() writes back into the fields.
int GetPreviewing () const
void SetPreviewing (int nPreviewing)
int GetSection () const
void SetSection (int nSection)
Public Member Functions inherited from ExternalPacket
 ExternalPacket (unsigned char nFlags=0, int nReceiver=kAllPeers)
 Construct a packet from an unset sender.
int Route () override
 Report that a received packet goes to the sink of TheNetTransport.
Public Member Functions inherited from Packet
void PrintExtra (PrnStream &stream) const override
 Write the sender and the receiver that are set, as from: and to:.
unsigned char GetFlags () const
int GetReceiver () const
int GetSender () const
void SetSender (int nSender)
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Static Public Member Functions

static Message * New ()
 Produce a default-constructed packet on the heap.
Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Additional Inherited Members

Public Types inherited from Packet
enum  RouteFlag { kRouteTransport = 1 , kRouteLaunchpad = 2 }
 Bits of Route(). More...
Static Public Attributes inherited from Packet
static constexpr int kUnset = -2
 Value of mSender and mReceiver that marks the member as unset.
static constexpr int kAllPeers = -1
 Value of mReceiver that addresses every peer.
static constexpr unsigned char kFlagOrdered = 1
 Bit of mFlags that LaunchpadRT::Send() turns into the second delivery bit of the session library.
static constexpr unsigned char kFlagGuaranteed = 2
 Bit of mFlags that NetTransport::Send() turns into its guaranteed delivery bit.
Protected Member Functions inherited from Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet that reports the remix editor's preview of a section started or stopped.

The RTTI records the class as deriving from ExternalPacket. Delivery is guaranteed. The members Clone(), Type(), and GetName() are inline. The member names are inferred.

Constructor & Destructor Documentation

◆ ~PreviewPacket()

PreviewPacket::~PreviewPacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0033df10
Ghidra address:
PAL: 0x003ab448

◆ PreviewPacket()

PreviewPacket::PreviewPacket ( )
inline

Construct a packet with no section.

Inline. New() expands it. mPreviewing is left unset.

Member Function Documentation

◆ New()

Message * PreviewPacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00123500
Ghidra address:
PAL: 0x00124c80

◆ operator new()

void * PreviewPacket::operator new ( size_t nSize)
inline

Allocate a packet, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void PreviewPacket::operator delete ( void * pBlock)
inline

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * PreviewPacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0033dfb0
Ghidra address:
PAL: 0x003ab4e8

Implements Message.

◆ Type()

int PreviewPacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nPreviewPacketType.
Ghidra address:
NTSC-U/C: 0x0033e028
Ghidra address:
PAL: 0x003ab560

Implements Message.

◆ GetName()

const char * PreviewPacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal PreviewPacket.
Ghidra address:
NTSC-U/C: 0x0033e038
Ghidra address:
PAL: 0x003ab570

Implements Message.

◆ saveGuts()

void PreviewPacket::saveGuts ( BinStream & stream) const
overridevirtual

Write the fields packed into one word.

The section takes the low 31 bits and the preview state the top bit.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x0012ef20
Ghidra address:
PAL: 0x001306f8

Reimplemented from Message.

◆ restoreGuts()

void PreviewPacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the word saveGuts() writes back into the fields.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x0012ef90
Ghidra address:
PAL: 0x00130768

Reimplemented from Message.

◆ GetPreviewing()

int PreviewPacket::GetPreviewing ( ) const
inline
Returns
Whether the preview started rather than stopped.

◆ SetPreviewing()

void PreviewPacket::SetPreviewing ( int nPreviewing)
inline
Parameters
nPreviewingWhether the preview started rather than stopped.

◆ GetSection()

int PreviewPacket::GetSection ( ) const
inline
Returns
The section previewed.

◆ SetSection()

void PreviewPacket::SetSection ( int nSection)
inline
Parameters
nSectionThe section previewed.

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