Mod.Show.SceneDetail.SceneDetail Class Reference

Public Member Functions
def	apply_data (self, val)
def	full_key (self)
def	scene_value (self)
def	set_doc (self, doc)

Static Public Attributes
bool	affects_persistence = False
string	class_id = ''
	data = None
	doc = None
	key = None
bool	mild_restore = False
	Storage field for TV. More...

Detailed Description

SceneDetail class: abstract class for tempovis scene save/restore plug-in. An implementation must provide:
* data storage (as "data" attribute of the object)
* constructor (preferably, with value for stored data as optional argument)
* methods to apply values to actual scene (apply_data), 
* ...and to read out the state of the detail in the actual scene (scene_value)
* keying, for identifying two detail instances that affect the exact same thing
* class_id string, which is required for keying
* copying
* test for equality, that checks if .data attributes of two SceneDetail instances are equal
* info on if the modification affects what is saved to disk, and thus should be undone temporarily for file writing.

Member Function Documentation

apply_data()

def Mod.Show.SceneDetail.SceneDetail.apply_data	(		self,
			val
	)

apply a value to scene

Reimplemented in Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane, Mod.Show.SceneDetails.ClipPlane.ClipPlane, Mod.Show.SceneDetails.Pickability.Pickability, Mod.Show.SceneDetails.VProperty.VProperty, Mod.Show.SceneDetails.Camera.Camera, and Mod.Show.SceneDetails.Workbench.Workbench.

References KDL::Stiffness.data, Mod.Show.SceneDetail.SceneDetail.data, KDL::Jacobian.data, KDL::RotationalInertia.data, KDL::JntArray.data, KDL::JntSpaceInertiaMatrix.data, Mod.Show.mTempoVis.TempoVis.data, SoVectorizeImage::Image.data, Array2D< T >.data, KDL::Vector.data, ArchSchedule._ArchSchedule.data, DrawingGui::TaskOrthoViews.data, KDL::Rotation.data, Dice3DS.dom3ds.UndefinedChunk.data, PathScripts.PathUtils.depth_params.data, KDL::Vector2.data, importIFClegacy.IfcSchema.data, importIFClegacy.IfcEntity.data, and importIFClegacy.IfcDocument.data.

full_key()

def Mod.Show.SceneDetail.SceneDetail.full_key

(

self

)

References BOPTools.Utils.HashableShape.__eq__(), addonmanager_macro.Macro.__eq__(), BOPTools.Utils.HashableShape_Deep.__eq__(), Mod.Show.SceneDetail.SceneDetail.__eq__(), Mod.Show.SceneDetail.SceneDetail.class_id, PathTests.TestPathUtil.TestPathUtil.doc, PathTests.TestPathToolController.TestPathToolController.doc, Mod.PartDesign.WizardShaft.WizardShaft.TaskWizardShaft.doc, Mod.Show.SceneDetail.SceneDetail.doc, PathTests.TestPathStock.TestPathStock.doc, PathTests.TestPathHelix.TestPathHelix.doc, PathTests.TestPathPost.PathPostTestCases.doc, PathTests.TestPathSetupSheet.TestPathSetupSheet.doc, drafttests.test_pivy.DraftPivy.doc, drafttests.test_dxf.DraftDXF.doc, drafttests.test_modification.DraftModification.doc, drafttests.test_oca.DraftOCA.doc, drafttests.test_dwg.DraftDWG.doc, drafttests.test_svg.DraftSVG.doc, drafttests.test_airfoildat.DraftAirfoilDAT.doc, drafttests.test_creation.DraftCreation.doc, Mod.PartDesign.WizardShaft.Shaft.Shaft.doc, Import::ImportOCAFAssembly.doc, Import::ImportOCAF.doc, Gui::GraphvizView.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, Sandbox::CustomAddObjectEvent.doc, draftguitools.gui_base.GuiCommandSimplest.doc, ExpressionCompleterModel::Info.doc, WorkingPlane.Plane.doc, PartGui::FaceColors::Private.doc, Sandbox::CustomRemoveObjectEvent.doc, PartDesignGui::ComboLinks.doc, App::RelabelDocumentExpressionVisitor.doc, Import::ImportXCAF.doc, Sandbox::CustomRecomputeEvent.doc, Sandbox::DocumentSaverThread.doc, draftguitools.gui_base_original.DraftTool.doc, App::DynamicProperty::PropData.doc, draftguitools.gui_base.GuiCommandBase.doc, App::LinkBaseExtension::PropInfo.doc, MeshPartGui::Mesh2ShapeGmsh::Private.doc, ItemInfo.doc, ItemInfo2.doc, importIFClegacy.IfcEntity.doc, Mod.Show.SceneDetail.SceneDetail.key, and Py::mapref< T >.key.

scene_value()

def Mod.Show.SceneDetail.SceneDetail.scene_value

(

self

)

scene_value(): returns the value from the scene

Reimplemented in Mod.Show.SceneDetails.ClipPlane.ClipPlane, Mod.Show.SceneDetails.Pickability.Pickability, Mod.Show.SceneDetails.VProperty.VProperty, Mod.Show.SceneDetails.Camera.Camera, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane, and Mod.Show.SceneDetails.Workbench.Workbench.

set_doc()

def Mod.Show.SceneDetail.SceneDetail.set_doc	(		self,
			doc
	)

References PathTests.TestPathUtil.TestPathUtil.doc, PathTests.TestPathToolController.TestPathToolController.doc, Mod.PartDesign.WizardShaft.WizardShaft.TaskWizardShaft.doc, Mod.Show.SceneDetail.SceneDetail.doc, PathTests.TestPathStock.TestPathStock.doc, PathTests.TestPathHelix.TestPathHelix.doc, PathTests.TestPathPost.PathPostTestCases.doc, PathTests.TestPathSetupSheet.TestPathSetupSheet.doc, drafttests.test_pivy.DraftPivy.doc, drafttests.test_dxf.DraftDXF.doc, drafttests.test_airfoildat.DraftAirfoilDAT.doc, drafttests.test_modification.DraftModification.doc, drafttests.test_oca.DraftOCA.doc, drafttests.test_svg.DraftSVG.doc, drafttests.test_dwg.DraftDWG.doc, drafttests.test_creation.DraftCreation.doc, Mod.PartDesign.WizardShaft.Shaft.Shaft.doc, Import::ImportOCAFAssembly.doc, Import::ImportOCAF.doc, Gui::GraphvizView.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, Sandbox::CustomAddObjectEvent.doc, draftguitools.gui_base.GuiCommandSimplest.doc, ExpressionCompleterModel::Info.doc, WorkingPlane.Plane.doc, PartGui::FaceColors::Private.doc, Sandbox::CustomRemoveObjectEvent.doc, PartDesignGui::ComboLinks.doc, App::RelabelDocumentExpressionVisitor.doc, Import::ImportXCAF.doc, Sandbox::CustomRecomputeEvent.doc, Sandbox::DocumentSaverThread.doc, draftguitools.gui_base_original.DraftTool.doc, App::DynamicProperty::PropData.doc, draftguitools.gui_base.GuiCommandBase.doc, App::LinkBaseExtension::PropInfo.doc, MeshPartGui::Mesh2ShapeGmsh::Private.doc, ItemInfo.doc, ItemInfo2.doc, and importIFClegacy.IfcEntity.doc.

Member Data Documentation

affects_persistence

bool Mod.Show.SceneDetail.SceneDetail.affects_persistence = False

static

class_id

string Mod.Show.SceneDetail.SceneDetail.class_id = ''

static

Referenced by Mod.Show.SceneDetail.SceneDetail.full_key().

data

Mod.Show.SceneDetail.SceneDetail.data = None

static

Referenced by Mod.Show.SceneDetail.SceneDetail.apply_data(), ArchSchedule.CommandArchSchedule.IsActive(), and FeaturePython.ViewProviderOctahedron.updateData().

doc

Mod.Show.SceneDetail.SceneDetail.doc = None

static

Referenced by Mod.Show.SceneDetails.Pickability.Pickability.apply_data(), Mod.Show.SceneDetails.VProperty.VProperty.apply_data(), Mod.Show.SceneDetails.ClipPlane.ClipPlane.apply_data(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.apply_data(), importSVG.svgHandler.characters(), importSVG.svgHandler.endElement(), Mod.Show.SceneDetail.SceneDetail.full_key(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.scene_value(), Mod.Show.SceneDetails.Pickability.Pickability.scene_value(), Mod.Show.SceneDetails.VProperty.VProperty.scene_value(), Mod.Show.SceneDetail.SceneDetail.set_doc(), TestSpreadsheet.SpreadsheetCases.tearDown(), TestSpreadsheet.SpreadsheetCases.testAggregates(), TestSpreadsheet.SpreadsheetCases.testAlias(), TestSpreadsheet.SpreadsheetCases.testAmbiguousAlias(), TestSpreadsheet.SpreadsheetCases.testClearAlias(), TestSpreadsheet.SpreadsheetCases.testCrossDocumentLinks(), TestSpreadsheet.SpreadsheetCases.testFunctions(), TestSpreadsheet.SpreadsheetCases.testInsertRows(), TestSpreadsheet.SpreadsheetCases.testInvoluteGear(), TestSpreadsheet.SpreadsheetCases.testIssue3128(), TestSpreadsheet.SpreadsheetCases.testIssue3225(), TestSpreadsheet.SpreadsheetCases.testIssue3363(), TestSpreadsheet.SpreadsheetCases.testIssue3432(), TestSpreadsheet.SpreadsheetCases.testMatrix(), TestSpreadsheet.SpreadsheetCases.testNumbers(), TestSpreadsheet.SpreadsheetCases.testPlacementName(), TestSpreadsheet.SpreadsheetCases.testPrecedence(), TestSpreadsheet.SpreadsheetCases.testRelationalOperators(), TestSpreadsheet.SpreadsheetCases.testRemoveRows(), TestSpreadsheet.SpreadsheetCases.testRenameAlias(), TestSpreadsheet.SpreadsheetCases.testRenameAlias2(), TestSpreadsheet.SpreadsheetCases.testRenameAlias3(), TestSpreadsheet.SpreadsheetCases.testSetInvalidAlias(), TestSpreadsheet.SpreadsheetCases.testSetInvalidAlias2(), TestSpreadsheet.SpreadsheetCases.testSketcher(), TestSpreadsheet.SpreadsheetCases.testUnits(), and Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.val().

key

Mod.Show.SceneDetail.SceneDetail.key = None

static

Referenced by Mod.Show.SceneDetail.SceneDetail.full_key().

mild_restore

bool Mod.Show.SceneDetail.SceneDetail.mild_restore = False

static

Storage field for TV.

Mild restore means that the saved state won't be restored if the current state differs from the state requested via last TempoVis.modify(...) call. This is a default, it may be changed per-instance.

---

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

• src/Mod/Show/SceneDetail.py