lc::operation::EntityBuilder Class Reference

#include <entitybuilder.h>

Inheritance diagram for lc::operation::EntityBuilder:

Collaboration diagram for lc::operation::EntityBuilder:

Public Member Functions
	EntityBuilder (Document_SPtr document)
	Builder constructor. More...
EntityBuilder *	appendEntity (entity::CADEntity_CSPtr cadEntity)
	append entity to the stack More...
EntityBuilder *	appendOperation (Base_SPtr operation)
	Append operation to the stack. More...
virtual void	undo () const
	Undo a given operation. More...
virtual void	redo () const
	Redo a given operation. More...
void	processStack ()
	Apply the operations Apply operations on the entities without updating the document, and clear the stack. More...
Public Member Functions inherited from lc::operation::DocumentOperation
	DocumentOperation (Document_SPtr document, const std::string &description)
Document_SPtr	document () const
virtual void	execute ()
	execute this operation More...
virtual	~DocumentOperation ()
Public Member Functions inherited from lc::operation::Undoable
	Undoable (const std::string &text)
	Name of this operartion. More...
virtual	~Undoable ()
virtual std::string	text ()
	Name of the operation. More...

Protected Member Functions
virtual void	processInternal ()

Private Attributes
std::vector< Base_SPtr >	_stack
std::vector < entity::CADEntity_CSPtr >	_workingBuffer
std::vector < entity::CADEntity_CSPtr >	_entitiesThatWhereUpdated
std::vector < entity::CADEntity_CSPtr >	_entitiesThatNeedsRemoval

Friends
class	lc::operation::Base

Detailed Description

Definition at line 15 of file entitybuilder.h.

Constructor & Destructor Documentation

EntityBuilder::EntityBuilder

(

Document_SPtr

document

)

Builder constructor.

Parameters

document

to apply operations

Definition at line 8 of file entitybuilder.cpp.

                                                             : 
        DocumentOperation(document, "EntityBuilder") {
}

Member Function Documentation

EntityBuilder * EntityBuilder::appendEntity

(

entity::CADEntity_CSPtr

cadEntity

)

append entity to the stack

Parameters

cadEntity

Returns

EntityOperation

Definition at line 12 of file entitybuilder.cpp.

                                                                          {
    _workingBuffer.push_back(cadEntity);
    return this;
}

EntityBuilder * EntityBuilder::appendOperation

(

Base_SPtr

operation

)

Append operation to the stack.

Parameters

operation

Returns

EntityOperation

Definition at line 17 of file entitybuilder.cpp.

                                                                 {
    _stack.push_back(operation);
    return this;
}

void EntityBuilder::processInternal ( )

protectedvirtual

This function gets called when an operation starts and when the document is locked for you so you can do your work

Implements lc::operation::DocumentOperation.

Definition at line 22 of file entitybuilder.cpp.

                                    {
    processStack();

    auto ec = document()->entityContainer();

    // Build a buffer with all entities we need to remove during a undo cycle
    for (auto entity : _workingBuffer) {
        auto org = ec.entityByID(entity->id());

        if (org.get() != nullptr) {
            _entitiesThatWhereUpdated.push_back(org);
        }
    }

    // Remove entities
    for (auto entity : _entitiesThatNeedsRemoval) {
        document()->removeEntity(entity);
    }

    // Add/Update all entities in the document
    for (auto entity : _workingBuffer) {
        document()->insertEntity(entity);
    }
}

void EntityBuilder::processStack

(

)

Apply the operations Apply operations on the entities without updating the document, and clear the stack.

Definition at line 71 of file entitybuilder.cpp.

                                 {
    std::vector<entity::CADEntity_CSPtr> entitySet;

    for (auto it = _stack.begin(); it != _stack.end(); ++it) {
        // Get looping stack, we currently support only one single loop!!
        std::vector<Base_SPtr> stack(_stack.begin(), it);
        entitySet = (*it)->process(document(), entitySet, _workingBuffer, _entitiesThatNeedsRemoval, stack);
    }

    _stack.clear();

    _workingBuffer.insert(_workingBuffer.end(), entitySet.begin(), entitySet.end());
}

void EntityBuilder::redo ( ) const

virtual

Redo a given operation.

This can get called if we want to redo a operation. Redo is usually called after an undo operation. If in the undo operation entities where removed, it needs to get added again. it doesn't have to do any re.calculation but just remember what entities have been added or removed.

Implements lc::operation::Undoable.

Definition at line 61 of file entitybuilder.cpp.

                               {
    for (auto entity : _entitiesThatNeedsRemoval) {
        document()->removeEntity(entity);
    }

    for (auto entity : _workingBuffer) {
        document()->insertEntity(entity);
    }
}

void EntityBuilder::undo ( ) const

virtual

Undo a given operation.

For any operation that means for example when it added entities to the document it now needs to remove all created entities on the document. When the operation added a layer or block, it will call functions to remove that block

Implements lc::operation::Undoable.

Definition at line 47 of file entitybuilder.cpp.

                               {
    for (auto entity : _workingBuffer) {
        document()->removeEntity(entity);
    }

    for (auto entity : _entitiesThatWhereUpdated) {
        document()->insertEntity(entity);
    }

    for (auto entity : _entitiesThatNeedsRemoval) {
        document()->insertEntity(entity);
    }
}

Friends And Related Function Documentation

friend class lc::operation::Base

friend

Definition at line 16 of file entitybuilder.h.

Member Data Documentation

std::vector<entity::CADEntity_CSPtr> lc::operation::EntityBuilder::_entitiesThatNeedsRemoval

private

Definition at line 56 of file entitybuilder.h.

std::vector<entity::CADEntity_CSPtr> lc::operation::EntityBuilder::_entitiesThatWhereUpdated

private

Definition at line 55 of file entitybuilder.h.

std::vector<Base_SPtr> lc::operation::EntityBuilder::_stack

private

Definition at line 52 of file entitybuilder.h.

std::vector<entity::CADEntity_CSPtr> lc::operation::EntityBuilder::_workingBuffer

private

Definition at line 53 of file entitybuilder.h.

---

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

• lckernel/cad/operations/entitybuilder.h
• lckernel/cad/operations/entitybuilder.cpp