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.Camera.Camera, Mod.Show.SceneDetails.ClipPlane.ClipPlane, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane, Mod.Show.SceneDetails.Pickability.Pickability, Mod.Show.SceneDetails.VProperty.VProperty, and Mod.Show.SceneDetails.Workbench.Workbench.

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.

◆ full_key()

def Mod.Show.SceneDetail.SceneDetail.full_key ( self )

◆ scene_value()

def Mod.Show.SceneDetail.SceneDetail.scene_value ( self )

scene_value(): returns the value from the scene

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

◆ set_doc()

def Mod.Show.SceneDetail.SceneDetail.set_doc	(	self,
		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.mTempoVis.TempoVis.activateWorkbench(), Mod.Show.SceneDetail.SceneDetail.apply_data(), importIFClegacy.IfcSchema.capitalize(), Mod.Show.mTempoVis.TempoVis.forget(), Mod.Show.mTempoVis.TempoVis.forgetDetail(), Mod.Show.mTempoVis.TempoVis.has(), ArchSchedule.CommandArchSchedule.IsActive(), importIFClegacy.IfcSchema.readEntities(), importIFClegacy.IfcSchema.readTypes(), Mod.Show.mTempoVis.TempoVis.restore(), Mod.Show.mTempoVis.TempoVis.save(), Mod.Show.mTempoVis.TempoVis.stored_val(), FeaturePython.ViewProviderOctahedron.updateData(), and Dice3DS.dom3ds.UndefinedChunk.write().

◆ doc

Mod.Show.SceneDetail.SceneDetail.doc = None

static

◆ 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:

FreeCAD/src/Mod/Show/SceneDetail.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ apply_data()

◆ full_key()

◆ scene_value()

◆ set_doc()

Member Data Documentation

◆ affects_persistence

◆ class_id

◆ data

◆ doc

◆ key

◆ mild_restore