Group of Gigasampler samples. More...

#include <gig.h>

Inheritance diagram for gig::Group:

Public Member Functions
Sample *	GetSample (size_t index)
	Returns Sample object at index of this sample group. More...

Sample *	GetFirstSample ()
	Returns the first Sample of this Group. More...

Sample *	GetNextSample ()
	Returns the next Sample of the Group. More...

void	AddSample (Sample *pSample)
	Move Sample given by pSample from another Group to this Group.

Public Attributes
String	Name
	Stores the name of this Group.

Protected Member Functions
	Group (File file, RIFF::Chunk ck3gnm)
	Constructor. More...

virtual	~Group ()
	Destructor. More...

virtual void	UpdateChunks (progress_t *pProgress)
	Update chunks with current group settings. More...

virtual void	DeleteChunks ()
	Remove all RIFF chunks associated with this Group object. More...

void	MoveAll ()
	Move all members of this group to another group (preferably the 1st one except this). More...

Detailed Description

Group of Gigasampler samples.

Groups help to organize a huge collection of Gigasampler samples. Groups are not concerned at all for the synthesis, but they help sound library developers when working on complex instruments with an instrument editor (as long as that instrument editor supports it ;-).

A sample is always assigned to exactly one Group. This also means there is always at least one Group in a .gig file, no matter if you created one yet or not.

Definition at line 1365 of file gig.h.

Constructor & Destructor Documentation

◆ Group()

gig::Group::Group	(	File *	file,
		RIFF::Chunk *	ck3gnm
	)

protected

Constructor.

Parameters

file	- pointer to the gig::File object
ck3gnm	- pointer to 3gnm chunk associated with this group or NULL if this is a new Group

Definition at line 6071 of file gig.cpp.

◆ ~Group()

gig::Group::~Group ( )

protectedvirtual

Destructor.

Currently this destructor implementation does nothing.

Definition at line 6082 of file gig.cpp.

Member Function Documentation

◆ DeleteChunks()

void gig::Group::DeleteChunks ( )

protectedvirtual

Remove all RIFF chunks associated with this Group object.

See DLS::Storage::DeleteChunks() for details.

Implements DLS::Storage.

Definition at line 6089 of file gig.cpp.

Referenced by gig::File::DeleteGroup(), and gig::File::DeleteGroupOnly().

◆ GetFirstSample()

Sample * gig::Group::GetFirstSample ( )

Returns the first Sample of this Group.

You have to call this method once before you use GetNextSample().

Notice: this method might block for a long time, in case the samples of this .gig file were not scanned yet

Returns: pointer address to first Sample or NULL if there is none applied to this Group

See also: GetNextSample()

Deprecated:: This method is not reentrant-safe, use GetSample() instead.

Definition at line 6165 of file gig.cpp.

References DLS::File::GetSample().

◆ GetNextSample()

Sample * gig::Group::GetNextSample ( )

Returns the next Sample of the Group.

You have to call GetFirstSample() once before you can use this method. By calling this method multiple times it iterates through the Samples assigned to this Group.