ClearMaterialDescendentsCommand

A DesignCommand that clears (removes) the material assignments from descendant objects. More...

Inheritance diagram for ClearMaterialDescendentsCommand:

Collaboration diagram for ClearMaterialDescendentsCommand:

Public Member Functions
	ClearMaterialDescendentsCommand ()
	Default constructor.
virtual	~ClearMaterialDescendentsCommand ()
	Default virtual destructor.
virtual bool	addTarget (UUID target_id) override
	Adds a target object whose material descendants should be cleared.
virtual void	execute (DesignObjectLookup *lookup) override
	Executes the command, clearing material assignments from descendant objects.
virtual StringView	icon () const override
	Returns the icon identifier for this command.
virtual TranslatedString	name () const override
	Returns the translated display name of this command.
Public Member Functions inherited from DesignCommand
	DesignCommand ()
	Default constructor.
	DesignCommand (const DesignCommand &command)=default
	Default copy constructor.
virtual	~DesignCommand ()
	Virtual destructor.
virtual bool	canCombineWith (const DynamicPointer< DesignCommand > &)
	Checks whether this command can be combined with another command into a single operation.
virtual bool	canGroupWith (const DynamicPointer< DesignCommand > &)
	Checks whether this command can be grouped with another command for batch execution.
virtual void	combineWith (const DynamicPointer< DesignCommand > &command)
	Combines this command with another compatible command, merging their operations.
virtual bool	isAsyncExecution () const
	Whether this command should be executed asynchronously.
void	setUndoRedoID (UUID undo_redo_group)
	Sets the undo-redo group identifier for this command.
UUID	undoRedoID () const
	Gets the undo-redo group identifier for this command.

Public Attributes
UUID	parent_id
	UUID of the parent object scoping the descendant search.
Public Attributes inherited from DesignCommand
bool	can_undo = true
	Whether this command supports being undone.
bool	has_executed = false
	Whether this command has already been executed.
UUID	id
	Unique identifier for this command instance.
bool	is_undo = false
	Whether this command represents an undo operation.
LogPtr	log
	Log pipe for reporting command progress and errors.
Time	time = Constant<Time>::Invalid
	Timestamp of when the command was created or executed.
bool	update_project_modified = true
	Whether executing this command should mark the project as modified.

Additional Inherited Members
Protected Attributes inherited from DesignCommand
UUID	m_undo_redo_group
	The undo-redo group this command belongs to, for batch undo/redo.

Detailed Description

A DesignCommand that clears (removes) the material assignments from descendant objects.

---

When executed, this command removes material references from the specified target objects. It stores the original material assignments so that the operation can be undone.

Definition at line 68 of file MaterialCommands.h.

Member Function Documentation

addTarget()

virtual bool ClearMaterialDescendentsCommand::addTarget ( UUID target_id )

inlineoverridevirtual

Adds a target object whose material descendants should be cleared.

Parameters

[in]

target_id

The UUID of the target design object.

Returns

True, indicating the target was accepted.

Reimplemented from DesignCommand.

Definition at line 100 of file MaterialCommands.h.

execute()

virtual void ClearMaterialDescendentsCommand::execute ( DesignObjectLookup * lookup )

overridevirtual

Executes the command, clearing material assignments from descendant objects.

Parameters

[in]

lookup

The DesignObjectLookup containing the target objects.

Reimplemented from DesignCommand.

icon()

virtual StringView ClearMaterialDescendentsCommand::icon ( ) const

overridevirtual

Returns the icon identifier for this command.

Returns

A StringView representing the icon name.

Implements DesignCommand.

name()

virtual TranslatedString ClearMaterialDescendentsCommand::name ( ) const

overridevirtual

Returns the translated display name of this command.

Returns

A TranslatedString containing the command name.

Implements DesignCommand.

---

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

• Design/Headers/MaterialCommands.h