SMTK
@SMTK_VERSION@
Simulation Modeling Tool Kit
|
Superclass for session-specific updates to arrangments of entities. More...
#include <ArrangementHelper.h>
Public Member Functions | |
smtkTypeMacroBase (ArrangementHelper) | |
ArrangementHelper (const ArrangementHelper &other)=delete | |
ArrangementHelper & | operator= (const ArrangementHelper &other)=delete |
virtual void | doneAddingEntities (SessionPtr sess, SessionInfoBits flags) |
This method is called after all related entities have been added and before arrangement updates are made. | |
void | mark (const EntityRef &ent, bool m) |
Mark an entity (as having been visited). | |
bool | isMarked (const EntityRef &ent) const |
Return whether an entity is marked or not. | |
void | resetMarks () |
Clear all the marks so that isMarked() returns false for any argument. | |
void | reset (const EntityRef &ent) |
Remove all relationships, arrangements, tessellations, and modeling-kernel-generated properties from the resource. More... | |
Protected Member Functions | |
ArrangementHelper () | |
Private constructor since this class is a base class which should not be instantiated. | |
Protected Attributes | |
EntityRefs | m_marked |
Friends | |
class | Session |
Superclass for session-specific updates to arrangments of entities.
Subclasses of this class are used by subclasses of the Session class to store session-specific information used to update arrangment information during transcription.
void smtk::model::ArrangementHelper::reset | ( | const EntityRef & | ent | ) |
Remove all relationships, arrangements, tessellations, and modeling-kernel-generated properties from the resource.
This method is invoked by Session instances inside transcribe().
Subclasses of ArrangementHelper should override this method, calling the parent class implementation (i.e., this method) before removing any kernel-specific properties added by their corresponding Session subclass. For example, the Exodus session adds the "exodus id" property. Since it will be regenerated by re-transcription, it should be removed in the Exodus session's ArrangementHelper subclass.