Digikam::FaceGroup Class Reference

Inheritance diagram for Digikam::FaceGroup:

Classes
class	Private

Public Slots
void	aboutToSetInfo (const ItemInfo &info)
void	aboutToSetInfoAfterRotate (const ItemInfo &info)
void	addFace ()
void	rejectAll ()
void	setInfo (const ItemInfo &info)
void	setVisible (bool visible)
void	setVisibleItem (RegionFrameItem *item)

Public Member Functions
bool	acceptsMouseClick (const QPointF &scenePos)
bool	autoSuggest () const
RegionFrameItem *	closestItem (const QPointF &p, qreal *const manhattanLength=nullptr) const
void	enterEvent (QEvent *)
	FaceGroup (GraphicsDImgView *const view)
bool	hasVisibleItems () const
ItemInfo	info () const
bool	isVisible () const
void	itemHoverEnterEvent (QGraphicsSceneHoverEvent *event)
void	itemHoverLeaveEvent (QGraphicsSceneHoverEvent *event)
void	itemHoverMoveEvent (QGraphicsSceneHoverEvent *event)
QList< RegionFrameItem * >	items () const
void	leaveEvent (QEvent *)
void	setAutoSuggest (bool doAutoSuggest)
void	setShowOnHover (bool show)
bool	showOnHover () const
	~FaceGroup () override

Protected Slots
void	cancelAddItem ()
void	focusRandomFace ()
void	itemStateChanged (int)
void	slotAddItemFinished (const QRectF &rect)
void	slotAddItemMoving (const QRectF &rect)
void	slotAddItemStarted (const QPointF &pos)
void	slotAlbumRenamed (Album *album)
void	slotAlbumsUpdated (int type)
void	slotAssigned (const TaggingAction &action, const ItemInfo &info, const QVariant &faceIdentifier)
void	slotIgnored (const ItemInfo &info, const QVariant &faceIdentifier)
void	slotIgnoredClicked (const ItemInfo &info, const QVariant &faceIdentifier)
void	slotLabelClicked (const ItemInfo &info, const QVariant &faceIdentifier)
void	slotRejected (const ItemInfo &info, const QVariant &faceIdentifier)
void	startAutoSuggest ()

Protected Member Functions
void	applyItemGeometryChanges ()
void	clear ()
void	load ()

Properties
bool	visible

Constructor & Destructor Documentation

FaceGroup()

Digikam::FaceGroup::FaceGroup ( GraphicsDImgView *const  view )

explicit

Constructs a new face group, managing RegionFrameItems for faces of a particular image, displayed on a GraphicsDImgView.

References Digikam::FacePipeline::construct(), Digikam::FaceGroup::Private::editPipeline, Digikam::AlbumManager::instance(), itemStateChanged(), Digikam::FacePipeline::plugDatabaseEditor(), Digikam::FacePipeline::plugTrainer(), Digikam::GraphicsDImgView::previewItem(), Digikam::ItemVisibilityController::setShallBeShown(), slotAlbumRenamed(), slotAlbumsUpdated(), Digikam::FaceGroup::Private::view, and Digikam::FaceGroup::Private::visibilityController.

~FaceGroup()

Digikam::FaceGroup::~FaceGroup ( )

override

Member Function Documentation

aboutToSetInfo

void Digikam::FaceGroup::aboutToSetInfo ( const ItemInfo &  info )

slot

Prepares to load a new info. Closes the face group for editing. Pass a null info if about to close.

References applyItemGeometryChanges(), clear(), info(), and Digikam::FaceGroup::Private::info.

aboutToSetInfoAfterRotate

void Digikam::FaceGroup::aboutToSetInfoAfterRotate ( const ItemInfo &  info )

slot

References clear(), info(), and Digikam::FaceGroup::Private::info.

acceptsMouseClick()

bool Digikam::FaceGroup::acceptsMouseClick

(

const QPointF &

scenePos

)

References Digikam::FaceGroup::Private::hotItems().

addFace

void Digikam::FaceGroup::addFace ( )

slot

Enters a special state where by click + drag a new face can be created

References cancelAddItem(), Digikam::FaceGroup::Private::manuallyAddWrapItem, Digikam::GraphicsDImgView::previewItem(), slotAddItemFinished(), slotAddItemMoving(), slotAddItemStarted(), and Digikam::FaceGroup::Private::view.

applyItemGeometryChanges()

void Digikam::FaceGroup::applyItemGeometryChanges ( )

protected

References Digikam::TagRegion::adjustToOrientation(), Digikam::DImg::copy(), Digikam::ItemInfo::dimensions(), Digikam::FaceGroup::Private::editPipeline, Digikam::FacePipeline::editRegion(), Digikam::FaceGroup::Private::exifRotate, Digikam::FaceItem::face(), Digikam::GraphicsDImgItem::image, Digikam::FaceGroup::Private::info, Digikam::FaceTagsIface::isNull(), Digikam::FaceGroup::Private::items, Digikam::ItemInfo::orientation(), Digikam::DImgChildItem::originalRect(), Digikam::GraphicsDImgView::previewItem(), Digikam::FaceTagsIface::region(), Digikam::DImg::rotateAndFlip(), and Digikam::FaceGroup::Private::view.

Referenced by aboutToSetInfo().

autoSuggest()

bool Digikam::FaceGroup::autoSuggest

(

)

const

References Digikam::FaceGroup::Private::autoSuggest.

cancelAddItem

void Digikam::FaceGroup::cancelAddItem ( )

protectedslot

References Digikam::FaceGroup::Private::manuallyAddedItem, Digikam::FaceGroup::Private::manuallyAddWrapItem, and Digikam::FaceGroup::Private::view.

Referenced by addFace(), clear(), and slotAddItemFinished().

clear()

void Digikam::FaceGroup::clear ( )

protected

References cancelAddItem(), Digikam::ItemVisibilityController::clear(), Digikam::FaceGroup::Private::items, Digikam::NoFaces, Digikam::FaceGroup::Private::state, and Digikam::FaceGroup::Private::visibilityController.

Referenced by aboutToSetInfo(), aboutToSetInfoAfterRotate(), rejectAll(), setInfo(), and slotAlbumsUpdated().

closestItem()

RegionFrameItem * Digikam::FaceGroup::closestItem	(	const QPointF &	p,
		qreal *const	manhattanLength = nullptr
	)		const

Returns the item in this group closest to scene position p. If given, manhattanLength is set to the manhattan length between p and the closest point of the returned item's bounding rectangle. In particular, if p is inside the item's rectangle, manhattanLength is 0.

References Digikam::RegionFrameItem::boundingRect(), and Digikam::FaceGroup::Private::items.

Referenced by itemHoverMoveEvent().

enterEvent()

void Digikam::FaceGroup::enterEvent

(

QEvent *

)

focusRandomFace

void Digikam::FaceGroup::focusRandomFace ( )

protectedslot

References Digikam::AssignNameWidget::comboBox(), Digikam::FaceItem::face(), Digikam::FaceTagsIface::isConfirmedName(), Digikam::FaceGroup::Private::items, Digikam::AddTagsComboBox::lineEdit(), and Digikam::FaceItem::widget().

Referenced by slotAssigned().

hasVisibleItems()

bool Digikam::FaceGroup::hasVisibleItems

(

)

const

References Digikam::ItemVisibilityController::hasVisibleItems(), and Digikam::FaceGroup::Private::visibilityController.

info()

ItemInfo Digikam::FaceGroup::info

(

)

const

References Digikam::FaceGroup::Private::info.

Referenced by aboutToSetInfo(), aboutToSetInfoAfterRotate(), Digikam::FaceGroup::Private::createAssignNameWidget(), Digikam::FaceGroup::Private::createItem(), and setInfo().

isVisible()

bool Digikam::FaceGroup::isVisible

(

)

const

References Digikam::ItemVisibilityController::shallBeShown, and Digikam::FaceGroup::Private::visibilityController.

Referenced by itemHoverMoveEvent(), and leaveEvent().

itemHoverEnterEvent()

void Digikam::FaceGroup::itemHoverEnterEvent

(

QGraphicsSceneHoverEvent *

event

)

itemHoverLeaveEvent()

void Digikam::FaceGroup::itemHoverLeaveEvent

(

QGraphicsSceneHoverEvent *

event

)

itemHoverMoveEvent()

void Digikam::FaceGroup::itemHoverMoveEvent

(

QGraphicsSceneHoverEvent *

event

)

References closestItem(), Digikam::ItemVisibilityController::ExcludeFadingOut, Digikam::FaceGroup::Private::hotItems(), isVisible(), setVisibleItem(), Digikam::FaceGroup::Private::showOnHover, Digikam::FaceGroup::Private::visibilityController, visible, and Digikam::ItemVisibilityController::visibleItems().

items()

QList< RegionFrameItem * > Digikam::FaceGroup::items

(

)

const

References Digikam::FaceGroup::Private::items.

Referenced by Digikam::FaceGroup::Private::addItem().

itemStateChanged

void Digikam::FaceGroup::itemStateChanged ( int  itemState )

protectedslot

References Digikam::FacesLoaded, Digikam::ItemVisibilityController::hide(), Digikam::DImgPreviewItem::ImageLoaded, Digikam::DImgPreviewItem::ImageLoadingFailed, Digikam::DImgPreviewItem::Loading, Digikam::DImgPreviewItem::NoImage, Digikam::ItemVisibilityController::show(), Digikam::FaceGroup::Private::state, and Digikam::FaceGroup::Private::visibilityController.

Referenced by FaceGroup().

leaveEvent()

void Digikam::FaceGroup::leaveEvent

(

QEvent *

)

References isVisible(), setVisibleItem(), and Digikam::FaceGroup::Private::showOnHover.

load()

void Digikam::FaceGroup::load ( )

protected

References Digikam::FaceGroup::Private::addItem(), Digikam::DImg::attribute(), Digikam::ItemVisibilityController::clear(), Digikam::FaceTagsEditor::databaseFaces(), Digikam::DImg::detectedFormat(), Digikam::MetaEngineSettingsContainer::exifRotate, Digikam::FaceGroup::Private::exifRotate, Digikam::FacesLoaded, Digikam::ItemInfo::id(), Digikam::GraphicsDImgItem::image, Digikam::FaceGroup::Private::info, Digikam::MetaEngineSettings::instance(), Digikam::DImgPreviewItem::isLoaded(), Digikam::ItemInfo::isNull(), Digikam::LoadingFaces, Digikam::NoFaces, Digikam::GraphicsDImgView::previewItem(), Digikam::DImg::RAW, Digikam::MetaEngineSettings::settings(), Digikam::ItemVisibilityController::show(), Digikam::FaceGroup::Private::state, Digikam::FaceGroup::Private::view, and Digikam::FaceGroup::Private::visibilityController.

Referenced by setInfo(), and slotAlbumsUpdated().

rejectAll

void Digikam::FaceGroup::rejectAll ( )

slot

Rejects (clears) all faces on the current image

References clear(), Digikam::ItemInfo::dimensions(), Digikam::ItemInfo::filePath(), Digikam::ItemInfo::id(), Digikam::FaceGroup::Private::info, Digikam::MetadataHub::load(), Digikam::MetadataHub::loadFaceTags(), Digikam::FaceTagsEditor::removeAllFaces(), Digikam::MetadataHub::write(), and Digikam::MetadataHub::WRITE_ALL.

setAutoSuggest()

void Digikam::FaceGroup::setAutoSuggest

(

bool

doAutoSuggest

)

Auto suggest applies if an image has not been scanned, or an unknown face is registered. In this case, a new scan will be triggered.

References Digikam::FaceGroup::Private::autoSuggest.

setInfo

void Digikam::FaceGroup::setInfo ( const ItemInfo &  info )

slot

Sets the current ItemInfo

References clear(), info(), Digikam::FaceGroup::Private::info, load(), Digikam::NoFaces, Digikam::ItemVisibilityController::shallBeShown, Digikam::FaceGroup::Private::state, and Digikam::FaceGroup::Private::visibilityController.

setShowOnHover()

void Digikam::FaceGroup::setShowOnHover

(

bool

show

)

Even if visible() is false, show the item under the mouse cursor

References Digikam::FaceGroup::Private::showOnHover.

setVisible

void Digikam::FaceGroup::setVisible ( bool  visible )

slot

Shows or hides the frames

References Digikam::FaceGroup::Private::applyVisible(), Digikam::ItemVisibilityController::setShallBeShown(), Digikam::FaceGroup::Private::visibilityController, and visible.

setVisibleItem

void Digikam::FaceGroup::setVisibleItem ( RegionFrameItem *  item )

slot

References Digikam::FaceGroup::Private::applyVisible(), Digikam::ItemVisibilityController::setItemThatShallBeShown(), and Digikam::FaceGroup::Private::visibilityController.

Referenced by itemHoverMoveEvent(), and leaveEvent().

showOnHover()

bool Digikam::FaceGroup::showOnHover

(

)

const

References Digikam::FaceGroup::Private::showOnHover.

slotAddItemFinished

void Digikam::FaceGroup::slotAddItemFinished ( const QRectF &  rect )

protectedslot

References Digikam::FaceGroup::Private::addItem(), Digikam::FacePipeline::addManually(), Digikam::TagRegion::adjustToOrientation(), cancelAddItem(), Digikam::DImg::copy(), Digikam::ItemInfo::dimensions(), Digikam::FaceGroup::Private::editPipeline, Digikam::FaceGroup::Private::exifRotate, Digikam::GraphicsDImgItem::image, Digikam::FaceGroup::Private::info, Digikam::FaceGroup::Private::manuallyAddedItem, Digikam::FaceGroup::Private::manuallyAddWrapItem, Digikam::ItemInfo::orientation(), Digikam::DImgChildItem::originalRect(), Digikam::GraphicsDImgView::previewItem(), Digikam::DImg::rotateAndFlip(), Digikam::ItemVisibilityController::setItemDirectlyVisible(), Digikam::RegionFrameItem::setRectInSceneCoordinatesAdjusted(), Digikam::FaceItem::switchMode(), Digikam::AssignNameWidget::UnconfirmedEditMode, Digikam::FaceGroup::Private::view, and Digikam::FaceGroup::Private::visibilityController.

Referenced by addFace().

slotAddItemMoving

void Digikam::FaceGroup::slotAddItemMoving ( const QRectF &  rect )

protectedslot

References Digikam::ItemVisibilityController::addItem(), Digikam::FaceGroup::Private::createItem(), Digikam::FaceGroup::Private::manuallyAddedItem, Digikam::RegionFrameItem::setRectInSceneCoordinatesAdjusted(), Digikam::ItemVisibilityController::showItem(), and Digikam::FaceGroup::Private::visibilityController.

Referenced by addFace().

slotAddItemStarted

void Digikam::FaceGroup::slotAddItemStarted ( const QPointF &  pos )

protectedslot

Referenced by addFace().

slotAlbumRenamed

void Digikam::FaceGroup::slotAlbumRenamed ( Album *  album )

protectedslot

References Digikam::FaceItem::face(), Digikam::Album::id(), Digikam::FaceTagsIface::isNull(), Digikam::FaceGroup::Private::items, Digikam::Album::TAG, Digikam::FaceTagsIface::tagId(), Digikam::Album::type(), and Digikam::FaceItem::updateCurrentTag().

Referenced by FaceGroup().

slotAlbumsUpdated

void Digikam::FaceGroup::slotAlbumsUpdated ( int  type )

protectedslot

References clear(), Digikam::FaceGroup::Private::items, load(), and Digikam::Album::TAG.

Referenced by FaceGroup().

slotAssigned

void Digikam::FaceGroup::slotAssigned ( const TaggingAction &  action, const ItemInfo &  info, const QVariant &  faceIdentifier  )

protectedslot

References Digikam::FacePipeline::confirm(), Digikam::AssignNameWidget::ConfirmedMode, Digikam::FaceGroup::Private::editPipeline, Digikam::FaceItem::face(), focusRandomFace(), Digikam::FaceTags::getOrCreateTagForPerson(), Digikam::GraphicsDImgItem::image, Digikam::FaceGroup::Private::info, Digikam::FaceTagsIface::isConfirmedName(), Digikam::FaceTags::isTheUnknownPerson(), Digikam::FaceGroup::Private::items, Digikam::TaggingAction::newTagName(), Digikam::DImgChildItem::originalRect(), Digikam::TaggingAction::parentTagId(), Digikam::GraphicsDImgView::previewItem(), Digikam::FaceTagsIface::region(), Digikam::FaceItem::setFace(), Digikam::TaggingAction::shallAssignTag(), Digikam::TaggingAction::shallCreateNewTag(), Digikam::FaceItem::switchMode(), Digikam::FaceTagsIface::tagId(), Digikam::TaggingAction::tagId(), and Digikam::FaceGroup::Private::view.

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

slotIgnored

void Digikam::FaceGroup::slotIgnored ( const ItemInfo &  info, const QVariant &  faceIdentifier  )

protectedslot

References Digikam::AssignNameWidget::ConfirmedMode, Digikam::FaceGroup::Private::editPipeline, Digikam::FacePipeline::editTag(), Digikam::FaceItem::face(), Digikam::FaceTags::ignoredPersonTagId(), Digikam::FaceGroup::Private::info, Digikam::FaceGroup::Private::items, Digikam::FaceItem::setFace(), and Digikam::FaceItem::switchMode().

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

slotIgnoredClicked

void Digikam::FaceGroup::slotIgnoredClicked ( const ItemInfo &  info, const QVariant &  faceIdentifier  )

protectedslot

References Digikam::FaceGroup::Private::items, Digikam::FaceItem::switchMode(), and Digikam::AssignNameWidget::UnconfirmedEditMode.

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

slotLabelClicked

void Digikam::FaceGroup::slotLabelClicked ( const ItemInfo &  info, const QVariant &  faceIdentifier  )

protectedslot

References Digikam::AssignNameWidget::ConfirmedEditMode, Digikam::FaceGroup::Private::items, and Digikam::FaceItem::switchMode().

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

slotRejected

void Digikam::FaceGroup::slotRejected ( const ItemInfo &  info, const QVariant &  faceIdentifier  )

protectedslot

References Digikam::FaceGroup::Private::editPipeline, Digikam::FaceItem::face(), Digikam::ItemVisibilityController::hideAndRemoveItem(), Digikam::FaceGroup::Private::info, Digikam::FaceGroup::Private::items, Digikam::FacePipeline::remove(), Digikam::FaceItem::setFace(), and Digikam::FaceGroup::Private::visibilityController.

Referenced by Digikam::FaceGroup::Private::createAssignNameWidget().

startAutoSuggest

void Digikam::FaceGroup::startAutoSuggest ( )

protectedslot

References Digikam::FaceGroup::Private::autoSuggest.

Property Documentation

visible

bool Digikam::FaceGroup::visible

readwrite

Referenced by itemHoverMoveEvent(), and setVisible().

---

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

• core/utilities/facemanagement/items/facegroup.h
• core/utilities/facemanagement/items/facegroup.cpp