Mod.Show.mTempoVis.TempoVis Class Reference

Public Member Functions

def activateWorkbench (self, wb_name)
 
def clipPlane (self, doc_obj_or_list, enable, placement, offset=0.02)
 
def forget (self)
 
def forgetDetail (self, detail)
 
def get_all_dependent (self, doc_obj, subname=None)
 
def has (self, detail)
 
def hide (self, doc_obj_or_list, links_too=True, mild_restore=None)
 
def hide_all_dependencies (self, doc_obj)
 
def hide_all_dependent (self, doc_obj)
 
def is_in_stack (self)
 
def modify (self, detail, mild_restore=None)
 
def modifyVPProperty (self, doc_obj_or_list, prop_names, new_value=JUST_SAVE, mild_restore=None)
 
def restore (self, ultimate=True)
 
def restore_all_dependent (self, doc_obj)
 
def restoreCamera (self, ultimate=False)
 
def restoreDetail (self, detail, ultimate=False)
 
def restoreVPProperty (self, doc_obj_or_list, prop_names)
 
def save (self, detail, mild_restore=False)
 
def saveBodyVisibleFeature (self, doc_obj_or_list)
 
def saveCamera (self, vw=None)
 
def setUnpickable (self, doc_obj_or_list, actual_pick_style=2)
 
def show (self, doc_obj_or_list, links_too=True, mild_restore=None)
 
def show_all_dependencies (self, doc_obj)
 
def show_all_dependent (self, doc_obj)
 
def sketchClipPlane (self, sketch, enable=None)
 
def stored_val (self, detail)
 

Static Public Member Functions

def allVisibleObjects (aroundObject)
 

Public Attributes

 tv_redo
 

Static Public Attributes

 data = None
 
 data_requested = None
 
 document = None
 
 stack = None
 
 state = S_EMPTY
 
string tag = ''
 

Detailed Description

TempoVis - helper object to save visibilities of objects before doing
some GUI editing, hiding or showing relevant stuff during edit, and
then restoring all visibilities after editing.

Constructors:
TempoVis(document, stack = MAINSTACK, **kwargs): creates a new TempoVis. 

document: required. Objects not belonging to the document can't be modified via TempoVis.

stack: optional. Which stack to insert this new TV into. Can be:
a TVStack instance (then, the new TV is added to the top of the stack), 
MAINSTACK special value (a global stack for the document will be used), or 
None (then, the TV is not in any stack, and can be manually instertd into one if desired).

Any additional keyword args are assigned as attributes. You can use it to immediately set a tag, for example.

Member Function Documentation

◆ activateWorkbench()

def Mod.Show.mTempoVis.TempoVis.activateWorkbench (   self,
  wb_name 
)

References Mod.Show.mTempoVis.TempoVis._purge_milds(), Mod.Show.mTempoVis.TempoVis._value_after(), App::Enumeration::Object.data(), PartGui::FilletRadiusModel.data(), Gui::Dialog::ButtonModel.data(), Gui::Dialog::CommandModel.data(), Gui::Dialog::PrintModel.data(), Gui::DocumentModel.data(), Gui::Dialog::DownloadModel.data(), ExpressionCompleterModel.data(), Gui::PropertyEditor::PropertyModel.data(), Gui::VectorTableModel.data(), PartGui::ResultModel.data(), SpreadsheetGui::SheetModel.data(), Gui::Dialog::ParameterGroupItem.data(), Gui::PropertyEditor::PropertyItem.data(), Gui::PropertyEditor::PropertyLinkItem.data(), Gui::DocumentModelIndex.data(), Gui::ApplicationIndex.data(), Gui::DocumentIndex.data(), Gui::ViewProviderIndex.data(), SelectionParser::StringFactory.data, SoVectorizeImage::Image.data, Gui::VectorListEditor.data, package_list.PackageListItemModel.data(), change_branch.ChangeBranchDialogModel.data(), ArchSchedule._ArchSchedule.data, Dice3DS.dom3ds.UndefinedChunk.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcEntity.data, importIFClegacy.IfcDocument.data, DrawingGui::TaskOrthoViews.data, PathScripts.PathUtils.depth_params.data, Array2D< float >.data, Array2D< T >.data, Array2D< char >.data, KDL::Vector2.data, KDL::Vector.data, KDL::Rotation.data, KDL::Jacobian.data, KDL::JntArray.data, KDL::JntSpaceInertiaMatrix.data, KDL::Stiffness.data, KDL::RotationalInertia.data, Mod.Show.mTempoVis.TempoVis.data, Mod.Show.SceneDetail.SceneDetail.data, Mod.Show.SceneDetails.ClipPlane.ClipPlane.data, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data, Mod.Show.SceneDetails.Pickability.Pickability.data, Mod.Show.SceneDetails.VProperty.VProperty.data, Mod.Show.SceneDetails.Workbench.Workbench.data, ConstraintItem.data(), Spreadsheet::PropertySheet.data, FeaturePython.ViewProviderOctahedron.data, Mod.Show.mTempoVis.TempoVis.data_requested, Mod.Show.mTempoVis.TempoVis.is_in_stack(), Mod.Show.mTempoVis.TempoVis.modify(), Gui::Dialog::Ui_DlgInputDialog.stack, Gui::View3DInventor.stack, draftguitools.gui_points.Point.stack, Mod.Show.mTempoVis.TempoVis.stack, Mod.Show.TVStack.TVStack.stack, Base::StdInputStream.state, Base::PyGILStateRelease.state, Gui::RunningState.state, SoGestureEvent.state, Gui::StatefulLabel.state, DraftGui.DraftToolBar.state, femsolver.run.Machine.state(), ifc2x3.ifcownerhistory.state, ifc4.ifcownerhistory.state, AdaptivePath::EngagePoint.state, Mod.Show.mTempoVis.TempoVis.state, importXLSX.exprNode.state, and Mod.Show.mTempoVis.Wrn.

◆ allVisibleObjects()

def Mod.Show.mTempoVis.TempoVis.allVisibleObjects (   aroundObject)
static
allVisibleObjects(aroundObject): returns list of objects that have to be toggled invisible for only aroundObject to remain. 
If a whole container can be made invisible, it is returned, instead of its child objects.

◆ clipPlane()

def Mod.Show.mTempoVis.TempoVis.clipPlane (   self,
  doc_obj_or_list,
  enable,
  placement,
  offset = 0.02 
)
clipPlane(doc_obj_or_list, enable, placement, offset): slices off the object with a clipping plane.
doc_obj_or_list: object or list of objects to alter (App)
enable: True if you want clipping, False if you want to remove clipping: 
placement: XY plane of local coordinates of the placement is the clipping plane. The placement must be in document's global coordinate system.
offset: shifts the plane. Positive offset reveals more of the object.

Implementation detail: uses SoClipPlane node. If viewprovider already has a node 
of this type as direct child, one is used. Otherwise, new one is created and 
inserted as the very first node. The node is left, but disabled when tempovis is restoring.

References Mod.Show.mTempoVis.TempoVis.modify().

◆ forget()

def Mod.Show.mTempoVis.TempoVis.forget (   self)
forget(self): clears this TV, making all changes done through it permanent. 
Also, withdraws the TV from the stack.

References App::Enumeration::Object.data(), PartGui::FilletRadiusModel.data(), Gui::Dialog::ButtonModel.data(), Gui::Dialog::CommandModel.data(), Gui::Dialog::PrintModel.data(), Gui::DocumentModel.data(), Gui::Dialog::DownloadModel.data(), ExpressionCompleterModel.data(), Gui::PropertyEditor::PropertyModel.data(), SelectionParser::StringFactory.data, SoVectorizeImage::Image.data, Gui::VectorTableModel.data(), Gui::Dialog::ParameterGroupItem.data(), Gui::PropertyEditor::PropertyItem.data(), Gui::PropertyEditor::PropertyLinkItem.data(), Gui::DocumentModelIndex.data(), Gui::ApplicationIndex.data(), Gui::DocumentIndex.data(), Gui::ViewProviderIndex.data(), Gui::VectorListEditor.data, package_list.PackageListItemModel.data(), change_branch.ChangeBranchDialogModel.data(), ArchSchedule._ArchSchedule.data, Dice3DS.dom3ds.UndefinedChunk.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcEntity.data, importIFClegacy.IfcDocument.data, PartGui::ResultModel.data(), DrawingGui::TaskOrthoViews.data, PathScripts.PathUtils.depth_params.data, Array2D< float >.data, Array2D< char >.data, Array2D< T >.data, KDL::Vector2.data, KDL::Vector.data, KDL::Jacobian.data, KDL::JntArray.data, KDL::Stiffness.data, KDL::Rotation.data, KDL::JntSpaceInertiaMatrix.data, KDL::RotationalInertia.data, Mod.Show.mTempoVis.TempoVis.data, Mod.Show.SceneDetail.SceneDetail.data, Mod.Show.SceneDetails.ClipPlane.ClipPlane.data, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data, Mod.Show.SceneDetails.Pickability.Pickability.data, Mod.Show.SceneDetails.VProperty.VProperty.data, Mod.Show.SceneDetails.Workbench.Workbench.data, ConstraintItem.data(), Spreadsheet::PropertySheet.data, SpreadsheetGui::SheetModel.data(), FeaturePython.ViewProviderOctahedron.data, Mod.Show.mTempoVis.TempoVis.is_in_stack(), Gui::Dialog::Ui_DlgInputDialog.stack, Gui::View3DInventor.stack, draftguitools.gui_points.Point.stack, Mod.Show.mTempoVis.TempoVis.stack, Mod.Show.TVStack.TVStack.stack, Base::StdInputStream.state, Base::PyGILStateRelease.state, Gui::RunningState.state, SoGestureEvent.state, Gui::StatefulLabel.state, DraftGui.DraftToolBar.state, femsolver.run.Machine.state(), ifc2x3.ifcownerhistory.state, ifc4.ifcownerhistory.state, AdaptivePath::EngagePoint.state, Mod.Show.mTempoVis.TempoVis.state, and importXLSX.exprNode.state.

◆ forgetDetail()

def Mod.Show.mTempoVis.TempoVis.forgetDetail (   self,
  detail 
)
forgetDetail(detail): ditches a saved detail value, making the change done through this TV permanent.

References App::Enumeration::Object.data(), Gui::Dialog::ButtonModel.data(), Gui::Dialog::CommandModel.data(), Gui::Dialog::PrintModel.data(), Gui::DocumentModel.data(), Gui::Dialog::DownloadModel.data(), ExpressionCompleterModel.data(), Gui::PropertyEditor::PropertyModel.data(), Gui::VectorTableModel.data(), Gui::Dialog::ParameterGroupItem.data(), Gui::PropertyEditor::PropertyItem.data(), Gui::PropertyEditor::PropertyLinkItem.data(), Gui::DocumentModelIndex.data(), Gui::ApplicationIndex.data(), Gui::DocumentIndex.data(), Gui::ViewProviderIndex.data(), SelectionParser::StringFactory.data, SoVectorizeImage::Image.data, Gui::VectorListEditor.data, package_list.PackageListItemModel.data(), change_branch.ChangeBranchDialogModel.data(), ArchSchedule._ArchSchedule.data, Dice3DS.dom3ds.UndefinedChunk.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcEntity.data, importIFClegacy.IfcDocument.data, PartGui::FilletRadiusModel.data(), PartGui::ResultModel.data(), DrawingGui::TaskOrthoViews.data, PathScripts.PathUtils.depth_params.data, Array2D< char >.data, Array2D< float >.data, Array2D< T >.data, KDL::Vector2.data, KDL::Vector.data, KDL::Stiffness.data, KDL::Rotation.data, KDL::Jacobian.data, KDL::JntArray.data, KDL::JntSpaceInertiaMatrix.data, KDL::RotationalInertia.data, Mod.Show.mTempoVis.TempoVis.data, Mod.Show.SceneDetail.SceneDetail.data, Mod.Show.SceneDetails.ClipPlane.ClipPlane.data, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data, Mod.Show.SceneDetails.Pickability.Pickability.data, Mod.Show.SceneDetails.VProperty.VProperty.data, Mod.Show.SceneDetails.Workbench.Workbench.data, ConstraintItem.data(), Spreadsheet::PropertySheet.data, SpreadsheetGui::SheetModel.data(), FeaturePython.ViewProviderOctahedron.data, and Mod.Show.mTempoVis.TempoVis.data_requested.

Referenced by Mod.Show.mTempoVis.TempoVis.restoreDetail().

◆ get_all_dependent()

def Mod.Show.mTempoVis.TempoVis.get_all_dependent (   self,
  doc_obj,
  subname = None 
)
get_all_dependent(doc_obj, subname = None): gets all objects that depend on doc_obj. Containers and Links (if subname) required for visibility of the object are excluded from the list.

Referenced by Mod.Show.mTempoVis.TempoVis.hide_all_dependent().

◆ has()

def Mod.Show.mTempoVis.TempoVis.has (   self,
  detail 
)
has(self, detail): returns True if this TV has this detail value saved.
example: tv.has(VProperty(obj, "Visibility"))

References App::Enumeration::Object.data(), Gui::Dialog::ButtonModel.data(), Gui::Dialog::CommandModel.data(), Gui::Dialog::PrintModel.data(), Gui::DocumentModel.data(), Gui::Dialog::DownloadModel.data(), ExpressionCompleterModel.data(), Gui::PropertyEditor::PropertyModel.data(), Gui::Dialog::ParameterGroupItem.data(), Gui::PropertyEditor::PropertyItem.data(), Gui::PropertyEditor::PropertyLinkItem.data(), Gui::DocumentModelIndex.data(), Gui::ApplicationIndex.data(), Gui::DocumentIndex.data(), Gui::ViewProviderIndex.data(), SelectionParser::StringFactory.data, SoVectorizeImage::Image.data, Gui::VectorTableModel.data(), Gui::VectorListEditor.data, package_list.PackageListItemModel.data(), change_branch.ChangeBranchDialogModel.data(), ArchSchedule._ArchSchedule.data, Dice3DS.dom3ds.UndefinedChunk.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcEntity.data, importIFClegacy.IfcDocument.data, PartGui::FilletRadiusModel.data(), PartGui::ResultModel.data(), DrawingGui::TaskOrthoViews.data, PathScripts.PathUtils.depth_params.data, Array2D< char >.data, Array2D< float >.data, Array2D< T >.data, KDL::Vector2.data, KDL::Vector.data, KDL::Stiffness.data, KDL::Rotation.data, KDL::Jacobian.data, KDL::JntArray.data, KDL::JntSpaceInertiaMatrix.data, KDL::RotationalInertia.data, Mod.Show.mTempoVis.TempoVis.data, Mod.Show.SceneDetail.SceneDetail.data, Mod.Show.SceneDetails.ClipPlane.ClipPlane.data, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data, Mod.Show.SceneDetails.Pickability.Pickability.data, Mod.Show.SceneDetails.VProperty.VProperty.data, Mod.Show.SceneDetails.Workbench.Workbench.data, ConstraintItem.data(), Spreadsheet::PropertySheet.data, SpreadsheetGui::SheetModel.data(), and FeaturePython.ViewProviderOctahedron.data.

Referenced by Mod.Show.mTempoVis.TempoVis.restoreDetail().

◆ hide()

def Mod.Show.mTempoVis.TempoVis.hide (   self,
  doc_obj_or_list,
  links_too = True,
  mild_restore = None 
)
hide(doc_obj_or_list): hides objects (sets their Visibility to False). doc_obj_or_list can be a document object, or a list of document objects

References Mod.Show.mTempoVis.TempoVis._3D_objects(), and Mod.Show.mTempoVis.TempoVis.modifyVPProperty().

Referenced by ArchComponent.ArchSelectionObserver.addSelection(), Mod.Show.mTempoVis.TempoVis.hide_all_dependencies(), Mod.Show.mTempoVis.TempoVis.hide_all_dependent(), PathScripts.PathToolEdit.ToolEditorImage.setupUI(), and PathScripts.PathToolEdit.ToolEditorImage.updateTool().

◆ hide_all_dependencies()

◆ hide_all_dependent()

◆ is_in_stack()

◆ modify()

def Mod.Show.mTempoVis.TempoVis.modify (   self,
  detail,
  mild_restore = None 
)
modify(detail, mild_restore = True): modifies scene detail through this TV. 
The value is provided as an instance of SceneDetail implementation.
The procedure takes care to account for the stack - that is, if in a TV applied 
later than this one this detail was changed too, the value saved therein is altered, 
rather than applied to the scene.

mild_restore: if True, when restoring later, checks if the value was changed 
by user after last call to modify(), and doesn't restore if it was changed.

Example: tv.modify(VProperty(obj, "Visibility", True))

References Mod.Show.mTempoVis.TempoVis._change(), Mod.Show.mTempoVis.TempoVis._value_after(), Mod.Show.mTempoVis.TempoVis.data_requested, Mod.Show.mTempoVis.TempoVis.modify(), Gui::RecentFilesAction.save(), Gui::RecentMacrosAction.save(), Gui::MacroCommand.save(), Gui::Dialog::DownloadManager.save(), Spreadsheet::Cell.save(), Mesh::Segment.save(), Points::PointKernel.save(), Mesh::MeshObject.save(), Sketcher::SketchObjectSF.save(), App::DynamicProperty.save(), Gui::PreferencePackManager.save(), WorkingPlane.Plane.save(), draftguitools.gui_setstyle.Draft_SetStyle_TaskPanel.save(), Mod.Show.mTempoVis.TempoVis.save(), App::Document.save(), and Gui::Document.save().

Referenced by Mod.Show.mTempoVis.TempoVis.activateWorkbench(), Mod.Show.mTempoVis.TempoVis.clipPlane(), Mod.Show.mTempoVis.TempoVis.modify(), Mod.Show.mTempoVis.TempoVis.modifyVPProperty(), Mod.Show.mTempoVis.TempoVis.setUnpickable(), and Mod.Show.mTempoVis.TempoVis.sketchClipPlane().

◆ modifyVPProperty()

def Mod.Show.mTempoVis.TempoVis.modifyVPProperty (   self,
  doc_obj_or_list,
  prop_names,
  new_value = JUST_SAVE,
  mild_restore = None 
)
modifyVPProperty(doc_obj_or_list, prop_names, new_value = JUST_SAVE, mild_restore = None): modifies
prop_name property of ViewProvider of doc_obj_or_list, and remembers
original value of the property. Original values will be restored upon
TempoVis deletion, or call to restore().

mild_restore: test if user changed the value manually when restoring the TV.

References Mod.Show.mTempoVis.TempoVis.modify(), Mod.Show.mTempoVis.TempoVis.restore(), Gui::RecentFilesAction.save(), Gui::RecentMacrosAction.save(), Gui::MacroCommand.save(), Gui::Dialog::DownloadManager.save(), Spreadsheet::Cell.save(), Mesh::Segment.save(), Points::PointKernel.save(), Mesh::MeshObject.save(), Sketcher::SketchObjectSF.save(), App::DynamicProperty.save(), Gui::PreferencePackManager.save(), WorkingPlane.Plane.save(), draftguitools.gui_setstyle.Draft_SetStyle_TaskPanel.save(), Mod.Show.mTempoVis.TempoVis.save(), App::Document.save(), Gui::Document.save(), Base::StdInputStream.state, Base::PyGILStateRelease.state, Gui::RunningState.state, SoGestureEvent.state, Gui::StatefulLabel.state, DraftGui.DraftToolBar.state, femsolver.run.Machine.state(), ifc2x3.ifcownerhistory.state, ifc4.ifcownerhistory.state, AdaptivePath::EngagePoint.state, Mod.Show.mTempoVis.TempoVis.state, importXLSX.exprNode.state, and Mod.Show.mTempoVis.Wrn.

Referenced by Mod.Show.mTempoVis.TempoVis.hide(), Mod.Show.mTempoVis.TempoVis.saveBodyVisibleFeature(), and Mod.Show.mTempoVis.TempoVis.show().

◆ restore()

def Mod.Show.mTempoVis.TempoVis.restore (   self,
  ultimate = True 
)
restore(ultimate = True): undoes all changes done through this tempovis / restores saved scene details.
ultimate: if true, the saved values are cleaned out, and the TV is withdrawn from 
the stack. If false, the TV will still remember stuff, and restore can be called again.

References Mod.Show.mTempoVis.TempoVis._restoreDetail(), App::Enumeration::Object.data(), PartGui::FilletRadiusModel.data(), Gui::Dialog::ButtonModel.data(), Gui::Dialog::CommandModel.data(), Gui::Dialog::PrintModel.data(), Gui::DocumentModel.data(), Gui::Dialog::DownloadModel.data(), ExpressionCompleterModel.data(), Gui::PropertyEditor::PropertyModel.data(), Gui::Dialog::ParameterGroupItem.data(), Gui::PropertyEditor::PropertyItem.data(), Gui::PropertyEditor::PropertyLinkItem.data(), Gui::DocumentModelIndex.data(), Gui::ApplicationIndex.data(), Gui::DocumentIndex.data(), Gui::ViewProviderIndex.data(), SelectionParser::StringFactory.data, SoVectorizeImage::Image.data, Gui::VectorTableModel.data(), Gui::VectorListEditor.data, package_list.PackageListItemModel.data(), ArchSchedule._ArchSchedule.data, Dice3DS.dom3ds.UndefinedChunk.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcDocument.data, PartGui::ResultModel.data(), change_branch.ChangeBranchDialogModel.data(), importIFClegacy.IfcEntity.data, DrawingGui::TaskOrthoViews.data, PathScripts.PathUtils.depth_params.data, Array2D< char >.data, Array2D< float >.data, Array2D< T >.data, KDL::Vector2.data, KDL::Vector.data, KDL::Rotation.data, KDL::Jacobian.data, KDL::JntArray.data, KDL::JntSpaceInertiaMatrix.data, KDL::Stiffness.data, KDL::RotationalInertia.data, Mod.Show.mTempoVis.TempoVis.data, Mod.Show.SceneDetail.SceneDetail.data, Mod.Show.SceneDetails.ClipPlane.ClipPlane.data, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data, Mod.Show.SceneDetails.Pickability.Pickability.data, Mod.Show.SceneDetails.VProperty.VProperty.data, Mod.Show.SceneDetails.Workbench.Workbench.data, Spreadsheet::PropertySheet.data, SpreadsheetGui::SheetModel.data(), ConstraintItem.data(), FeaturePython.ViewProviderOctahedron.data, Mod.Show.mTempoVis.Err, Mod.Show.mTempoVis.TempoVis.is_in_stack(), Gui::Dialog::Ui_DlgInputDialog.stack, Gui::View3DInventor.stack, draftguitools.gui_points.Point.stack, Mod.Show.mTempoVis.TempoVis.stack, Mod.Show.TVStack.TVStack.stack, Base::StdInputStream.state, Base::PyGILStateRelease.state, Gui::RunningState.state, SoGestureEvent.state, Gui::StatefulLabel.state, DraftGui.DraftToolBar.state, femsolver.run.Machine.state(), ifc2x3.ifcownerhistory.state, ifc4.ifcownerhistory.state, AdaptivePath::EngagePoint.state, Mod.Show.mTempoVis.TempoVis.state, and importXLSX.exprNode.state.

Referenced by Mod.Show.mTempoVis.TempoVis.modifyVPProperty(), and Mod.Show.mTempoVis.TempoVis.setUnpickable().

◆ restore_all_dependent()

def Mod.Show.mTempoVis.TempoVis.restore_all_dependent (   self,
  doc_obj 
)
show_all_dependent(doc_obj): restores original visibilities of all dependent objects.

References Mod.Show.mTempoVis.TempoVis.restoreVPProperty().

◆ restoreCamera()

def Mod.Show.mTempoVis.TempoVis.restoreCamera (   self,
  ultimate = False 
)

References App::DocumentT.document, App::DocumentObjectT.document, Gui::DocumentT.document, Gui::ViewProviderT.document, Gui::MergeDocuments.document, Gui::DocumentItem.document(), DraftUtils::DraftDxfRead.document, femmesh.meshsetsgetter.MeshSetsGetter.document, femsolver.writerbase.FemInputWriter.document, femtest.app.test_ccxtools.TestCcxTools.document, femtest.app.test_common.TestFemCommon.document, femtest.app.test_femimport.TestObjectExistance.document, femtest.app.test_material.TestMaterialUnits.document, femtest.app.test_mesh.TestMeshCommon.document, femtest.app.test_mesh.TestMeshEleTetra10.document, femtest.app.test_mesh.TestMeshGroups.document, femtest.app.test_object.TestObjectCreate.document, femtest.app.test_object.TestObjectType.document, femtest.app.test_open.TestObjectOpen.document, femtest.app.test_result.TestResult.document, femtest.app.test_solver_calculix.TestSolverCalculix.document, femtest.app.test_solver_elmer.TestSolverElmer.document, femtest.app.test_solver_mystran.TestSolverMystran.document, femtest.app.test_solver_z88.TestSolverZ88.document, femtest.gui.test_open.TestObjectOpen.document, Import::ImpExpDxfRead.document, Mesh::Importer.document, MeshPartGui::Tessellation.document, PartGui::DlgExtrusion.document, PartGui::Mirroring.document, PartGui::LoftWidget::Private.document, PartGui::SweepWidget::Private.document, Mod.Show.mTempoVis.TempoVis.document, Mod.Show.TVStack.TVStack.document, MRichTextEdit.document(), and Mod.Show.mTempoVis.TempoVis.restoreDetail().

◆ restoreDetail()

def Mod.Show.mTempoVis.TempoVis.restoreDetail (   self,
  detail,
  ultimate = False 
)
restoreDetail(detail, ultimate = False): restores a specific scene detail.
ultimate: if true, the saved value is cleaned out.
If the detail is not found, nothing is done.

References Mod.Show.mTempoVis.TempoVis.forgetDetail(), Path::Command.has(), and Mod.Show.mTempoVis.TempoVis.has().

Referenced by Mod.Show.mTempoVis.TempoVis.restoreCamera(), and Mod.Show.mTempoVis.TempoVis.restoreVPProperty().

◆ restoreVPProperty()

def Mod.Show.mTempoVis.TempoVis.restoreVPProperty (   self,
  doc_obj_or_list,
  prop_names 
)
restoreVPProperty(doc_obj_or_list, prop_name, new_value): restores specific property changes.

References Mod.Show.mTempoVis.Err, and Mod.Show.mTempoVis.TempoVis.restoreDetail().

Referenced by Mod.Show.mTempoVis.TempoVis.restore_all_dependent().

◆ save()

def Mod.Show.mTempoVis.TempoVis.save (   self,
  detail,
  mild_restore = False 
)
save(detail, mild_restore = False):saves the scene detail to be restored. 
The detail is saved only once; repeated calls are ignored.
mild_restore: internal, do not use.

References Mod.Show.mTempoVis.TempoVis._change(), Mod.Show.mTempoVis.TempoVis._value_after(), App::Enumeration::Object.data(), PartGui::FilletRadiusModel.data(), Gui::Dialog::ButtonModel.data(), Gui::Dialog::CommandModel.data(), Gui::Dialog::PrintModel.data(), Gui::DocumentModel.data(), Gui::Dialog::DownloadModel.data(), ExpressionCompleterModel.data(), Gui::PropertyEditor::PropertyModel.data(), Gui::Dialog::ParameterGroupItem.data(), Gui::PropertyEditor::PropertyItem.data(), Gui::PropertyEditor::PropertyLinkItem.data(), Gui::DocumentModelIndex.data(), Gui::ApplicationIndex.data(), Gui::DocumentIndex.data(), Gui::ViewProviderIndex.data(), SelectionParser::StringFactory.data, SoVectorizeImage::Image.data, Gui::VectorTableModel.data(), Gui::VectorListEditor.data, package_list.PackageListItemModel.data(), change_branch.ChangeBranchDialogModel.data(), ArchSchedule._ArchSchedule.data, Dice3DS.dom3ds.UndefinedChunk.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcEntity.data, importIFClegacy.IfcDocument.data, PartGui::ResultModel.data(), DrawingGui::TaskOrthoViews.data, PathScripts.PathUtils.depth_params.data, Array2D< char >.data, Array2D< T >.data, Array2D< float >.data, KDL::Vector2.data, KDL::Vector.data, KDL::Rotation.data, KDL::Jacobian.data, KDL::JntArray.data, KDL::JntSpaceInertiaMatrix.data, KDL::Stiffness.data, KDL::RotationalInertia.data, Mod.Show.mTempoVis.TempoVis.data, Mod.Show.SceneDetail.SceneDetail.data, Mod.Show.SceneDetails.ClipPlane.ClipPlane.data, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data, Mod.Show.SceneDetails.Pickability.Pickability.data, Mod.Show.SceneDetails.VProperty.VProperty.data, Mod.Show.SceneDetails.Workbench.Workbench.data, SpreadsheetGui::SheetModel.data(), ConstraintItem.data(), Spreadsheet::PropertySheet.data, and FeaturePython.ViewProviderOctahedron.data.

Referenced by Mod.Show.mTempoVis.TempoVis.modify(), Mod.Show.mTempoVis.TempoVis.modifyVPProperty(), draftguitools.gui_setstyle.Draft_SetStyle_TaskPanel.onSaveStyle(), and Mod.Show.mTempoVis.TempoVis.saveCamera().

◆ saveBodyVisibleFeature()

def Mod.Show.mTempoVis.TempoVis.saveBodyVisibleFeature (   self,
  doc_obj_or_list 
)
saveBodyVisibleFeature(self, doc_obj_or_list): saves Visibility of currently 
visible feature, for every body of PartDesign features in the provided list.

References Mod.Show.mTempoVis.TempoVis.modifyVPProperty().

Referenced by Mod.Show.mTempoVis.TempoVis.show().

◆ saveCamera()

def Mod.Show.mTempoVis.TempoVis.saveCamera (   self,
  vw = None 
)

References Mod.Show.mTempoVis.TempoVis._change(), App::DocumentT.document, App::DocumentObjectT.document, Gui::DocumentT.document, Gui::ViewProviderT.document, Gui::MergeDocuments.document, Gui::DocumentItem.document(), DraftUtils::DraftDxfRead.document, femmesh.meshsetsgetter.MeshSetsGetter.document, femsolver.writerbase.FemInputWriter.document, femtest.app.test_ccxtools.TestCcxTools.document, femtest.app.test_common.TestFemCommon.document, femtest.app.test_femimport.TestObjectExistance.document, femtest.app.test_material.TestMaterialUnits.document, femtest.app.test_mesh.TestMeshCommon.document, femtest.app.test_mesh.TestMeshEleTetra10.document, femtest.app.test_mesh.TestMeshGroups.document, femtest.app.test_object.TestObjectCreate.document, femtest.app.test_object.TestObjectType.document, femtest.app.test_open.TestObjectOpen.document, femtest.app.test_result.TestResult.document, femtest.app.test_solver_calculix.TestSolverCalculix.document, femtest.app.test_solver_elmer.TestSolverElmer.document, femtest.app.test_solver_mystran.TestSolverMystran.document, femtest.app.test_solver_z88.TestSolverZ88.document, femtest.gui.test_open.TestObjectOpen.document, Import::ImpExpDxfRead.document, Mesh::Importer.document, MeshPartGui::Tessellation.document, PartGui::DlgExtrusion.document, PartGui::Mirroring.document, PartGui::LoftWidget::Private.document, PartGui::SweepWidget::Private.document, Mod.Show.mTempoVis.TempoVis.document, Mod.Show.TVStack.TVStack.document, MRichTextEdit.document(), Gui::RecentFilesAction.save(), Gui::RecentMacrosAction.save(), Gui::MacroCommand.save(), Gui::Dialog::DownloadManager.save(), Spreadsheet::Cell.save(), Mesh::Segment.save(), Points::PointKernel.save(), Mesh::MeshObject.save(), Sketcher::SketchObjectSF.save(), App::DynamicProperty.save(), Gui::PreferencePackManager.save(), WorkingPlane.Plane.save(), draftguitools.gui_setstyle.Draft_SetStyle_TaskPanel.save(), Mod.Show.mTempoVis.TempoVis.save(), App::Document.save(), and Gui::Document.save().

◆ setUnpickable()

def Mod.Show.mTempoVis.TempoVis.setUnpickable (   self,
  doc_obj_or_list,
  actual_pick_style = 2 
)
setUnpickable(doc_obj_or_list, actual_pick_style = 2): sets object unpickable (transparent to clicks).
doc_obj_or_list: object or list of objects to alter (App)
actual_pick_style: optional parameter, specifying the actual pick style: 
0 = regular, 1 = bounding box, 2 (default) = unpickable.

Implementation detail: uses SoPickStyle node. If viewprovider already has a node 
of this type as direct child, one is used. Otherwise, new one is created and 
inserted as the very first node, and remains there even after restore()/deleting 
tempovis. 

References Mod.Show.mTempoVis.TempoVis.modify(), and Mod.Show.mTempoVis.TempoVis.restore().

◆ show()

def Mod.Show.mTempoVis.TempoVis.show (   self,
  doc_obj_or_list,
  links_too = True,
  mild_restore = None 
)
show(doc_obj_or_list, links_too = True): shows objects (sets their Visibility to True). 
doc_obj_or_list can be a document object, or a list of document objects.
If links_too is True, all Links of the objects are also hidden, by setting LinkVisibility attribute of each object.

References Mod.Show.mTempoVis.TempoVis._3D_objects(), Mod.Show.mTempoVis.TempoVis.modifyVPProperty(), and Mod.Show.mTempoVis.TempoVis.saveBodyVisibleFeature().

Referenced by Mod.Show.mTempoVis.TempoVis.show_all_dependencies(), and Mod.Show.mTempoVis.TempoVis.show_all_dependent().

◆ show_all_dependencies()

◆ show_all_dependent()

◆ sketchClipPlane()

def Mod.Show.mTempoVis.TempoVis.sketchClipPlane (   self,
  sketch,
  enable = None 
)
sketchClipPlane(sketch, enable = None): Clips all objects by plane of sketch. 
If enable argument is omitted, calling the routine repeatedly will toggle clipping plane.

References Mod.Show.mTempoVis.TempoVis.modify().

◆ stored_val()

def Mod.Show.mTempoVis.TempoVis.stored_val (   self,
  detail 
)
stored_val(self, detail): returns value of detail remembered by this TV. If not, raises KeyError.

References App::Enumeration::Object.data(), Gui::Dialog::ButtonModel.data(), Gui::Dialog::CommandModel.data(), Gui::Dialog::PrintModel.data(), Gui::DocumentModel.data(), Gui::Dialog::DownloadModel.data(), ExpressionCompleterModel.data(), Gui::PropertyEditor::PropertyModel.data(), Gui::Dialog::ParameterGroupItem.data(), Gui::PropertyEditor::PropertyItem.data(), Gui::PropertyEditor::PropertyLinkItem.data(), Gui::DocumentModelIndex.data(), Gui::ApplicationIndex.data(), Gui::DocumentIndex.data(), Gui::ViewProviderIndex.data(), SelectionParser::StringFactory.data, SoVectorizeImage::Image.data, Gui::VectorTableModel.data(), Gui::VectorListEditor.data, package_list.PackageListItemModel.data(), change_branch.ChangeBranchDialogModel.data(), ArchSchedule._ArchSchedule.data, Dice3DS.dom3ds.UndefinedChunk.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcEntity.data, importIFClegacy.IfcDocument.data, PartGui::FilletRadiusModel.data(), PartGui::ResultModel.data(), DrawingGui::TaskOrthoViews.data, PathScripts.PathUtils.depth_params.data, Array2D< char >.data, Array2D< float >.data, Array2D< T >.data, KDL::Vector2.data, KDL::Vector.data, KDL::Stiffness.data, KDL::Rotation.data, KDL::Jacobian.data, KDL::JntArray.data, KDL::JntSpaceInertiaMatrix.data, KDL::RotationalInertia.data, Mod.Show.mTempoVis.TempoVis.data, Mod.Show.SceneDetail.SceneDetail.data, Mod.Show.SceneDetails.ClipPlane.ClipPlane.data, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data, Mod.Show.SceneDetails.Pickability.Pickability.data, Mod.Show.SceneDetails.VProperty.VProperty.data, Mod.Show.SceneDetails.Workbench.Workbench.data, ConstraintItem.data(), Spreadsheet::PropertySheet.data, SpreadsheetGui::SheetModel.data(), and FeaturePython.ViewProviderOctahedron.data.

Member Data Documentation

◆ data

◆ data_requested

◆ document

Mod.Show.mTempoVis.TempoVis.document = None
static

Referenced by femtest.app.test_solver_calculix.TestSolverCalculix.input_file_writing_test(), femtest.app.test_solver_elmer.TestSolverElmer.input_file_writing_test(), femtest.app.test_solver_mystran.TestSolverMystran.input_file_writing_test(), femtest.app.test_ccxtools.TestCcxTools.input_file_writing_test(), femtest.app.test_solver_z88.TestSolverZ88.inputfile_writing_test(), Mod.Show.mTempoVis.TempoVis.restoreCamera(), femtest.app.test_ccxtools.TestCcxTools.result_reading_test(), Mod.Show.mTempoVis.TempoVis.saveCamera(), femtest.app.test_ccxtools.TestCcxTools.tearDown(), femtest.app.test_common.TestFemCommon.tearDown(), femtest.app.test_femimport.TestObjectExistance.tearDown(), femtest.app.test_material.TestMaterialUnits.tearDown(), femtest.app.test_mesh.TestMeshCommon.tearDown(), femtest.app.test_mesh.TestMeshEleTetra10.tearDown(), femtest.app.test_mesh.TestMeshGroups.tearDown(), femtest.app.test_object.TestObjectCreate.tearDown(), femtest.app.test_object.TestObjectType.tearDown(), femtest.app.test_open.TestObjectOpen.tearDown(), femtest.app.test_result.TestResult.tearDown(), femtest.app.test_solver_calculix.TestSolverCalculix.tearDown(), femtest.app.test_solver_elmer.TestSolverElmer.tearDown(), femtest.app.test_solver_mystran.TestSolverMystran.tearDown(), femtest.app.test_solver_z88.TestSolverZ88.tearDown(), femtest.gui.test_open.TestObjectOpen.tearDown(), femtest.app.test_common.TestFemCommon.test_adding_refshaps(), femtest.app.test_ccxtools.TestCcxTools.test_box_frequency(), femtest.app.test_solver_calculix.TestSolverCalculix.test_box_frequency(), femtest.app.test_ccxtools.TestCcxTools.test_box_static(), femtest.app.test_solver_calculix.TestSolverCalculix.test_box_static(), femtest.app.test_solver_elmer.TestSolverElmer.test_box_static_0_mm(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_buckling_flexuralbuckling(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_beam_circle(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_beam_pipe(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_beam_rect(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_ele_hexa20(), femtest.app.test_solver_z88.TestSolverZ88.test_ccx_cantilever_ele_hexa20(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_ele_quad4(), femtest.app.test_solver_mystran.TestSolverMystran.test_ccx_cantilever_ele_quad4(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_ele_quad8(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_ele_seg2(), femtest.app.test_solver_mystran.TestSolverMystran.test_ccx_cantilever_ele_seg2(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_ele_seg3(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_ele_tria3(), femtest.app.test_solver_mystran.TestSolverMystran.test_ccx_cantilever_ele_tria3(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_ele_tria6(), femtest.app.test_solver_z88.TestSolverZ88.test_ccx_cantilever_ele_tria6(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_faceload(), femtest.app.test_solver_mystran.TestSolverMystran.test_ccx_cantilever_faceload(), femtest.app.test_solver_z88.TestSolverZ88.test_ccx_cantilever_faceload(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_nodeload(), femtest.app.test_solver_mystran.TestSolverMystran.test_ccx_cantilever_nodeload(), femtest.app.test_solver_z88.TestSolverZ88.test_ccx_cantilever_nodeload(), femtest.app.test_solver_calculix.TestSolverCalculix.test_ccx_cantilever_prescribeddisplacement(), femtest.app.test_solver_elmer.TestSolverElmer.test_ccxcantilever_faceload_0_mm(), femtest.app.test_solver_elmer.TestSolverElmer.test_ccxcantilever_faceload_1_si(), femtest.app.test_solver_elmer.TestSolverElmer.test_ccxcantilever_nodeload_0_mm(), femtest.app.test_solver_elmer.TestSolverElmer.test_ccxcantilever_prescribeddisplacement_0_mm(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_centrif(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_contact_shell_shell(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_contact_solid_solid(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_sectionprint(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_selfweight_cantilever(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_tie(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_transform_beam_hinged(), femtest.app.test_solver_calculix.TestSolverCalculix.test_constraint_transform_torque(), femtest.app.test_object.TestObjectType.test_femobjects_derivedfromfem(), femtest.app.test_object.TestObjectType.test_femobjects_derivedfromstd(), femtest.app.test_object.TestObjectType.test_femobjects_isoftype(), femtest.app.test_object.TestObjectCreate.test_femobjects_make(), femtest.app.test_open.TestObjectOpen.test_femobjects_open_de9b3fb438(), femtest.gui.test_open.TestObjectOpen.test_femobjects_open_de9b3fb438(), femtest.app.test_open.TestObjectOpen.test_femobjects_open_head(), femtest.gui.test_open.TestObjectOpen.test_femobjects_open_head(), femtest.app.test_object.TestObjectType.test_femobjects_type(), femtest.app.test_solver_calculix.TestSolverCalculix.test_frequency_beamsimple(), femtest.app.test_solver_calculix.TestSolverCalculix.test_material_multiple_bendingbeam_fiveboxes(), femtest.app.test_solver_calculix.TestSolverCalculix.test_material_multiple_bendingbeam_fivefaces(), femtest.app.test_solver_calculix.TestSolverCalculix.test_material_multiple_tensionrod_twoboxes(), femtest.app.test_solver_calculix.TestSolverCalculix.test_material_nonlinear(), femtest.app.test_solver_mystran.TestSolverMystran.test_mystran_plate(), femtest.app.test_femimport.TestObjectExistance.test_objects_existance(), femtest.app.test_solver_calculix.TestSolverCalculix.test_square_pipe_end_twisted_edgeforces(), femtest.app.test_solver_calculix.TestSolverCalculix.test_square_pipe_end_twisted_nodeforces(), femtest.app.test_solver_calculix.TestSolverCalculix.test_thermomech_bimetall(), femtest.app.test_ccxtools.TestCcxTools.test_thermomech_flow1D(), femtest.app.test_solver_calculix.TestSolverCalculix.test_thermomech_flow1D(), femtest.app.test_ccxtools.TestCcxTools.test_thermomech_spine(), femtest.app.test_solver_calculix.TestSolverCalculix.test_thermomech_spine(), and Mod.Show.TVStack.TVStack.unwindForSaving().

◆ stack

◆ state

◆ tag

◆ tv_redo

Mod.Show.mTempoVis.TempoVis.tv_redo

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