Inheritance diagram for RegionOwnedObject:

[legend]

Collaboration diagram for RegionOwnedObject:

[legend]

Public Member Functions
	RegionOwnedObject (ArrangerObjectRegistry &obj_registry) noexcept

void	set_region_and_index (const Region &region)
	Sets the region the object belongs to and the related index inside it.

template<typename SelfT>
void	get_global_start_pos (this const SelfT &self, dsp::Position &pos, dsp::FramesPerTick frames_per_tick)
	Gets the global (timeline-based) start Position of the object.

template<typename SelfT>
auto	get_region (this const SelfT &self)
	If the object is part of a Region, returns it, otherwise returns NULL.

Public Member Functions inherited from ArrangerObject
auto	get_type () const

virtual utils::Utf8String	gen_human_friendly_name () const
	Generates a human readable name for the object.

bool	is_start_hit_by_range (const dsp::Position &start, const dsp::Position &end, bool range_start_inclusive=true, bool range_end_inclusive=false) const
	Returns whether the given object is hit by the given range.

bool	is_start_hit_by_range (const signed_frame_t global_frames_start, const signed_frame_t global_frames_end, bool range_start_inclusive=true, bool range_end_inclusive=false) const

void	set_parent_on_base_qproperties (QObject &derived)
	Set the parent on QObject's that are children of this class.

auto	get_position () const
	Getter.

void	position_setter_validated (const dsp::Position &pos, dsp::TicksPerFrame ticks_per_frame)
	The setter is for use in e.g.

void	set_position_unvalidated (const dsp::Position &pos)

bool	is_position_valid (const dsp::Position &pos, PositionType pos_type, dsp::TicksPerFrame ticks_per_frame) const
	Returns if the given Position is valid.

bool	set_position (const dsp::Position &pos, PositionType pos_type, bool validate, dsp::TicksPerFrame ticks_per_frame)
	Sets the given position on the object, optionally attempting to validate before.

void	move (double ticks, dsp::FramesPerTick frames_per_tick)
	Moves the object by the given amount of ticks.

void	set_track_id (const TrackUuid &track_id)

void	set_track_id (std::optional< TrackUuid > track_id)

void	unset_track_id ()

void	update_positions (bool from_ticks, bool bpm_change, dsp::FramesPerTick frames_per_tick)
	Updates the positions in each child recursively.

auto	get_track () const
	Returns the Track this ArrangerObject is in.

std::optional< TrackUuid >	get_track_id () const

virtual bool	validate (bool is_project, dsp::FramesPerTick frames_per_tick) const =0
	Validates the arranger object.

virtual ArrangerObjectPtrVariant	add_clone_to_project (bool fire_events) const =0
	Appends the ArrangerObject to where it belongs in the project (eg, a Track), without taking into account its previous index (eg, before deletion if undoing).

virtual ArrangerObjectPtrVariant	insert_clone_to_project () const =0
	Inserts the object where it belongs in the project (eg, a Track).

std::optional< ArrangerObjectPtrVariant >	remove_from_project (bool free_obj, bool fire_events=false)
	Removes the object (which can be obtained from find_in_project()) from its parent in the project.

void	set_selection_status_getter (SelectionStatusGetter getter)

void	unset_selection_status_getter ()

virtual bool	is_deletable () const
	Returns whether the given object is deletable or not (eg, start marker).

Public Member Functions inherited from zrythm::utils::UuidIdentifiableObject< ArrangerObject >
	UuidIdentifiableObject (const Uuid &id)

	UuidIdentifiableObject (const UuidIdentifiableObject &other)=default

	UuidIdentifiableObject (UuidIdentifiableObject &&other)=default

UuidIdentifiableObject &	operator= (const UuidIdentifiableObject &other)=default

UuidIdentifiableObject &	operator= (UuidIdentifiableObject &&other)=default

auto	get_uuid () const

void	copy_members_from (const UuidIdentifiableObject &other)

Data Fields
ArrangerObjectRegistry &	object_registry_

std::optional< ArrangerObject::Uuid >	region_id_
	Parent region identifier for objects that are part of a region.

Data Fields inherited from ArrangerObject
Flags	flags_ {}
	Track this object belongs to (cache to be set during graph calculation).

Protected Member Functions
void	copy_members_from (const RegionOwnedObject &other, ObjectCloneType clone_type)

Protected Member Functions inherited from ArrangerObject
	ArrangerObject (Type type, TrackResolver track_resolver) noexcept

void	copy_members_from (const ArrangerObject &other, ObjectCloneType clone_type)

bool	are_members_valid (bool is_project, dsp::FramesPerTick frames_per_tick) const
	To be called by validate() implementations.

Friends
bool	operator== (const RegionOwnedObject &lhs, const RegionOwnedObject &rhs)

void	to_json (nlohmann::json &j, const RegionOwnedObject &object)

void	from_json (const nlohmann::json &j, RegionOwnedObject &object)

Additional Inherited Members
Public Types inherited from ArrangerObject
enum class	ResizeType { Normal , Loop , Fade , Stretch , StretchTempoChange }
	Flag used in some functions. More...

enum class	Type { MidiRegion , AudioRegion , ChordRegion , AutomationRegion , MidiNote , ChordObject , ScaleObject , Marker , AutomationPoint }
	The type of the object. More...

enum class	Flags { NonProject = 1 << 0 }
	Flags. More...

enum class	PositionType { Start , End , ClipStart , LoopStart , LoopEnd , FadeIn , FadeOut }

using	SelectionStatusGetter = std::function<bool (const Uuid &)>

using	Position = zrythm::dsp::Position

using	ArrangerObjectPtr = ArrangerObject *

Static Public Attributes inherited from ArrangerObject
static constexpr double	DEFAULT_NUDGE_TICKS = 0.1

Protected Attributes inherited from ArrangerObject
TrackResolver	track_resolver_

PositionProxy *	pos_ = nullptr
	Position (or start Position if the object has length).

std::optional< TrackUuid >	track_id_
	ID of the track this object belongs to.

std::optional< SelectionStatusGetter >	selection_status_getter_
	Whether part of an auditioner track.

Detailed Description

Definition at line 11 of file region_owned_object.h.

Constructor & Destructor Documentation

◆ RegionOwnedObject()

RegionOwnedObject::RegionOwnedObject ( ArrangerObjectRegistry & obj_registry )

inlinenoexcept

Definition at line 14 of file region_owned_object.h.

Member Function Documentation

◆ get_global_start_pos()

template<typename SelfT>

void RegionOwnedObject::get_global_start_pos	(	this const SelfT &	self,
		dsp::Position &	pos,
		dsp::FramesPerTick	frames_per_tick )

inline

Gets the global (timeline-based) start Position of the object.

Parameters

[out] pos Position to fill in.

Definition at line 32 of file region_owned_object.h.

◆ get_region()

template<typename SelfT>

auto RegionOwnedObject::get_region ( this const SelfT & self )

inline

If the object is part of a Region, returns it, otherwise returns NULL.

Definition at line 46 of file region_owned_object.h.

Friends And Related Symbol Documentation

◆ from_json

void from_json	(	const nlohmann::json &	j,
		RegionOwnedObject &	object )

friend

Definition at line 66 of file region_owned_object.h.

◆ operator==

bool operator==	(	const RegionOwnedObject &	lhs,
		const RegionOwnedObject &	rhs )

friend

Definition at line 82 of file region_owned_object.h.

◆ to_json

void to_json	(	nlohmann::json &	j,
		const RegionOwnedObject &	object )

friend

Definition at line 62 of file region_owned_object.h.

Field Documentation

◆ object_registry_

ArrangerObjectRegistry& RegionOwnedObject::object_registry_

Definition at line 72 of file region_owned_object.h.

◆ region_id_

std::optional<ArrangerObject::Uuid> RegionOwnedObject::region_id_

Parent region identifier for objects that are part of a region.

Definition at line 75 of file region_owned_object.h.

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

src/gui/dsp/region_owned_object.h

Public Member Functions

Data Fields

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RegionOwnedObject()

Member Function Documentation

◆ get_global_start_pos()

◆ get_region()

Friends And Related Symbol Documentation

◆ from_json

◆ operator==

◆ to_json

Field Documentation

◆ object_registry_

◆ region_id_