FreeCAD: Mod.Show.SceneDetails.ClipPlane.ClipPlane Class Reference

Public Member Functions
def	apply_data (self, val)

def	scene_value (self)

Public Member Functions inherited from Mod.Show.SceneDetail.SceneDetail
def	apply_data (self, val)

def	full_key (self)

def	scene_value (self)

def	set_doc (self, doc)

Public Attributes
	data

	doc

Static Public Attributes
string	class_id = 'SDClipPlane'

string	key = ''

Static Public Attributes inherited from Mod.Show.SceneDetail.SceneDetail
bool	affects_persistence = False

string	class_id = ''

	data = None

	doc = None

	key = None

bool	mild_restore = False
	Storage field for TV. More...

Detailed Description

ClipPlane(document, enable = None, placement = None, offset = 0.0):
TempoVis plugin for applying clipping plane to whole project except edit root.
enable can be 0 for disable, 1 for enable, and -1 for toggle 
(FIXME: toggle value support is a hack for while we can't read out the current state).

Member Function Documentation

◆ apply_data()

def Mod.Show.SceneDetails.ClipPlane.ClipPlane.apply_data	(		self,
			val
	)

apply a value to scene

Reimplemented from Mod.Show.SceneDetail.SceneDetail.

References Gui::GLFlagWindow._viewer, Gui::AbstractSplitView._viewer, Gui::View3DInventor._viewer, Gui::View3DInventorViewerPy._viewer, Mod.Show.SceneDetails.Camera.Camera._viewer(), Mod.Show.SceneDetails.ClipPlane.ClipPlane._viewer(), App::DynamicProperty::PropData.doc, App::RelabelDocumentExpressionVisitor.doc, App::LinkBaseExtension::PropInfo.doc, Py::PythonType.doc(), ExpressionCompleterModel::Info.doc, Gui::GraphvizView.doc, ItemInfo.doc, ItemInfo2.doc, importIFClegacy.IfcEntity.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, draftguitools.gui_base.GuiCommandSimplest.doc, draftguitools.gui_base.GuiCommandBase.doc, draftguitools.gui_base_original.DraftTool.doc, drafttests.test_airfoildat.DraftAirfoilDAT.doc, drafttests.test_creation.DraftCreation.doc, drafttests.test_dwg.DraftDWG.doc, drafttests.test_dxf.DraftDXF.doc, drafttests.test_modification.DraftModification.doc, drafttests.test_oca.DraftOCA.doc, drafttests.test_pivy.DraftPivy.doc, drafttests.test_svg.DraftSVG.doc, WorkingPlane.Plane.doc, Import::ImportOCAF.doc, Import::ImportXCAF.doc, Import::ImportOCAFAssembly.doc, MeshPartGui::Mesh2ShapeGmsh::Private.doc, PartGui::SectionCut.doc, PartGui::FaceColors::Private.doc, PartDesignGui::ComboLinks.doc, Mod.PartDesign.WizardShaft.Shaft.Shaft.doc, Mod.PartDesign.WizardShaft.WizardShaft.TaskWizardShaft.doc, PathTests.TestCentroidPost.TestCentroidPost.doc, PathTests.TestGrblPost.TestGrblPost.doc, PathTests.TestLinuxCNCPost.TestLinuxCNCPost.doc, PathTests.TestMach3Mach4Post.TestMach3Mach4Post.doc, PathTests.TestPathAdaptive.TestPathAdaptive.doc, PathTests.TestPathDrillable.TestPathDrillable.doc, PathTests.TestPathHelix.TestPathHelix.doc, PathTests.TestPathHelpers.TestPathHelpers.doc, PathTests.TestPathPost.TestBuildPostList.doc, PathTests.TestPathPost.TestOutputNameSubstitution.doc, PathTests.TestPathPropertyBag.TestPathPropertyBag.doc, PathTests.TestPathSetupSheet.TestPathSetupSheet.doc, PathTests.TestPathStock.TestPathStock.doc, PathTests.TestPathToolController.TestPathToolController.doc, PathTests.TestPathUtil.TestPathUtil.doc, PathTests.TestRefactoredCentroidPost.TestRefactoredCentroidPost.doc, PathTests.TestRefactoredGrblPost.TestRefactoredGrblPost.doc, PathTests.TestRefactoredLinuxCNCPost.TestRefactoredLinuxCNCPost.doc, PathTests.TestRefactoredMach3Mach4Post.TestRefactoredMach3Mach4Post.doc, PathTests.TestRefactoredTestPost.TestRefactoredTestPost.doc, Sandbox::CustomAddObjectEvent.doc, Sandbox::CustomRemoveObjectEvent.doc, Sandbox::CustomRecomputeEvent.doc, Sandbox::DocumentSaverThread.doc, Mod.Show.SceneDetail.SceneDetail.doc, Mod.Show.SceneDetails.Camera.Camera.doc, Mod.Show.SceneDetails.ClipPlane.ClipPlane.doc, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.doc, Mod.Show.SceneDetails.Pickability.Pickability.doc, Mod.Show.SceneDetails.VProperty.VProperty.doc, TestSpreadsheet.SpreadsheetCases.doc, TestSpreadsheetGui.SpreadsheetGuiCases.doc, and Commands.TemplatePyMod_Cmd2.doc.

◆ scene_value()

def Mod.Show.SceneDetails.ClipPlane.ClipPlane.scene_value ( self )

scene_value(): returns the value from the scene

Reimplemented from Mod.Show.SceneDetail.SceneDetail.

Member Data Documentation

◆ class_id

string Mod.Show.SceneDetails.ClipPlane.ClipPlane.class_id = 'SDClipPlane'

static

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

◆ data

Mod.Show.SceneDetails.ClipPlane.ClipPlane.data

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.SceneDetails.ClipPlane.ClipPlane.doc

Referenced by draftguitools.gui_lineslope.LineSlope.accept(), draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_base.GuiCommandSimplest.Activated(), draftguitools.gui_beziers.BezCurve.Activated(), draftguitools.gui_beziers.CubicBezCurve.Activated(), draftguitools.gui_dimension_ops.FlipDimension.Activated(), draftguitools.gui_groups.AddToConstruction.Activated(), draftguitools.gui_heal.Heal.Activated(), draftguitools.gui_layers.Layer.Activated(), draftguitools.gui_splines.BSpline.Activated(), draftguitools.gui_wire2spline.WireToBSpline.Activated(), draftguitools.gui_lines.Line.Activated(), WorkingPlane.Plane.alignToPointAndAxis(), WorkingPlane.Plane.alignToPointAndAxis_SVG(), Mod.Show.SceneDetails.ClipPlane.ClipPlane.apply_data(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.apply_data(), Mod.Show.SceneDetails.Pickability.Pickability.apply_data(), Mod.Show.SceneDetails.VProperty.VProperty.apply_data(), importSVG.svgHandler.characters(), draftguitools.gui_drawing.Drawing.createDefaultPage(), draftguitools.gui_fillets.Fillet.draw_arc(), importSVG.svgHandler.endElement(), draftguitools.gui_arcs.Arc_3Points.finish(), draftguitools.gui_fillets.Fillet.finish(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_splines.BSpline.finish(), Mod.Show.SceneDetail.SceneDetail.full_key(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.get_annotations(), importIFClegacy.IfcEntity.getProperties(), importIFClegacy.IfcEntity.getProperty(), draftguitools.gui_groups.AddToGroup.proceed(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.read_meta(), draftguitools.gui_trimex.Trimex.redraw(), draftguitools.gui_lines.Line.removeTemporaryObject(), WorkingPlane.Plane.reset(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.save_meta(), 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(), drafttests.test_creation.DraftCreation.tearDown(), PathTests.TestPathDrillable.TestPathDrillable.tearDown(), PathTests.TestPathHelix.TestPathHelix.tearDown(), PathTests.TestPathPropertyBag.TestPathPropertyBag.tearDown(), PathTests.TestPathSetupSheet.TestPathSetupSheet.tearDown(), PathTests.TestPathToolController.TestPathToolController.tearDown(), TestSpreadsheet.SpreadsheetCases.tearDown(), PathTests.TestPathSetupSheet.TestPathSetupSheet.test00(), PathTests.TestPathUtil.TestPathUtil.test00(), PathTests.TestPathPost.TestOutputNameSubstitution.test000(), PathTests.TestPathSetupSheet.TestPathSetupSheet.test01(), PathTests.TestPathUtil.TestPathUtil.test01(), PathTests.TestPathAdaptive.TestPathAdaptive.test02(), PathTests.TestPathUtil.TestPathUtil.test02(), PathTests.TestPathAdaptive.TestPathAdaptive.test03(), PathTests.TestPathHelix.TestPathHelix.test03(), PathTests.TestPathUtil.TestPathUtil.test03(), PathTests.TestPathAdaptive.TestPathAdaptive.test04(), PathTests.TestPathHelix.TestPathHelix.test04(), PathTests.TestPathUtil.TestPathUtil.test04(), PathTests.TestPathAdaptive.TestPathAdaptive.test05(), PathTests.TestPathAdaptive.TestPathAdaptive.test06(), PathTests.TestPathAdaptive.TestPathAdaptive.test07(), PathTests.TestPathSetupSheet.TestPathSetupSheet.test13(), drafttests.test_creation.DraftCreation.test_dimension_linear_obj(), drafttests.test_creation.DraftCreation.test_dimension_radial_obj(), drafttests.test_creation.DraftCreation.test_facebinder(), drafttests.test_creation.DraftCreation.test_fillet(), drafttests.test_creation.DraftCreation.test_label(), TestSpreadsheet.SpreadsheetCases.testAggregates(), TestSpreadsheet.SpreadsheetCases.testAlias(), TestSpreadsheet.SpreadsheetCases.testAmbiguousAlias(), TestSpreadsheet.SpreadsheetCases.testBindAcrossSheets(), TestSpreadsheet.SpreadsheetCases.testBindHiddenRefAcrossSheets(), TestSpreadsheet.SpreadsheetCases.testClearAlias(), TestSpreadsheetGui.SpreadsheetGuiCases.testCopySingleCell(), TestSpreadsheet.SpreadsheetCases.testCrossDocumentLinks(), TestSpreadsheet.SpreadsheetCases.testExpressionWithAlias(), TestSpreadsheet.SpreadsheetCases.testFixPR6843(), TestSpreadsheet.SpreadsheetCases.testFunctions(), TestSpreadsheet.SpreadsheetCases.testInsertColumnsAlias(), TestSpreadsheet.SpreadsheetCases.testInsertRows(), TestSpreadsheet.SpreadsheetCases.testInsertRowsAlias(), TestSpreadsheet.SpreadsheetCases.testInvoluteGear(), TestSpreadsheet.SpreadsheetCases.testIssue3128(), TestSpreadsheet.SpreadsheetCases.testIssue3225(), TestSpreadsheet.SpreadsheetCases.testIssue3363(), TestSpreadsheet.SpreadsheetCases.testIssue3432(), TestSpreadsheet.SpreadsheetCases.testIssue4156(), TestSpreadsheet.SpreadsheetCases.testIssue6840(), TestSpreadsheet.SpreadsheetCases.testIssue6844(), TestSpreadsheet.SpreadsheetCases.testMatrix(), TestSpreadsheet.SpreadsheetCases.testMergeCells(), TestSpreadsheet.SpreadsheetCases.testMergeCellsAndBind(), TestSpreadsheet.SpreadsheetCases.testNumbers(), TestSpreadsheet.SpreadsheetCases.testPlacementName(), TestSpreadsheet.SpreadsheetCases.testPrecedence(), TestSpreadsheet.SpreadsheetCases.testQuantitiesAndFractionsAsNumbers(), TestSpreadsheet.SpreadsheetCases.testRelationalOperators(), TestSpreadsheet.SpreadsheetCases.testRemoveColumnsAlias(), TestSpreadsheet.SpreadsheetCases.testRemoveColumnsAliasReuseName(), TestSpreadsheet.SpreadsheetCases.testRemoveRows(), TestSpreadsheet.SpreadsheetCases.testRemoveRowsAlias(), TestSpreadsheet.SpreadsheetCases.testRemoveRowsAliasReuseName(), TestSpreadsheet.SpreadsheetCases.testRenameAlias(), TestSpreadsheet.SpreadsheetCases.testRenameAlias2(), TestSpreadsheet.SpreadsheetCases.testRenameAlias3(), TestSpreadsheet.SpreadsheetCases.testSetInvalidAlias(), TestSpreadsheet.SpreadsheetCases.testSetInvalidAlias2(), TestSpreadsheet.SpreadsheetCases.testSketcher(), TestSpreadsheet.SpreadsheetCases.testUndoAliasCreationReuseName(), TestSpreadsheet.SpreadsheetCases.testUnits(), draftguitools.gui_trimex.Trimex.trimObject(), draftguitools.gui_trimex.Trimex.trimObjects(), Mod.PartDesign.WizardShaft.Shaft.Shaft.updateConstraint(), Mod.PartDesign.WizardShaft.Shaft.Shaft.updateEdge(), and Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.val().

◆ key

string Mod.Show.SceneDetails.ClipPlane.ClipPlane.key = ''

static

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

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

FreeCAD/src/Mod/Show/SceneDetails/ClipPlane.py