Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane Class Reference

Public Member Functions
def	apply_data (self, val)
def	scene_value (self)
def	val (self, enable, placement=None, offset=0.0)
Public Member Functions inherited from Mod.Show.SceneDetail.SceneDetail
def	full_key (self)
def	set_doc (self, doc)

Public Attributes
	data
	doc
	key
	objname

Static Public Attributes
string	class_id = 'SDObjectClipPlane'
string	objname = ''
string	propname = ''
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

ObjectClipPlane(object, enable = None, placement = None, offset = 0.0):
Plugin for TempoVis for adding clipping planes to individual objects.

Member Function Documentation

apply_data()

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

apply a value to scene

Reimplemented from Mod.Show.SceneDetail.SceneDetail.

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, importIFClegacy.IfcEntity.doc, Mod.Show.SceneDetails.ObjectClipPlane.getClipPlaneNode(), and Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.objname.

scene_value()

def Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.scene_value

(

self

)

scene_value(): returns the value from the scene

Reimplemented from Mod.Show.SceneDetail.SceneDetail.

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, importIFClegacy.IfcEntity.doc, Mod.Show.SceneDetails.ObjectClipPlane.getClipPlaneNode(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.objname, and Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.val().

val()

def Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.val	(		self,
			enable,
			placement = None,
			offset = 0.0
	)

val(enable, placement = None, offset = 0.0): constructs a value from convenient 
parameters. Placement is in global CS. The cutting will be by XY plane of Placement; 
the stuff in negative Z is visible and the stuff in positive Z is invisible.

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, importIFClegacy.IfcEntity.doc, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.objname, and Mod.Show.SceneDetails.ObjectClipPlane.placement2plane().

Referenced by Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.scene_value().

Member Data Documentation

class_id

string Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.class_id = 'SDObjectClipPlane'

static

data

Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.data

Referenced by ArchSchedule.CommandArchSchedule.IsActive(), and FeaturePython.ViewProviderOctahedron.updateData().

doc

Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.doc

Referenced by importSVG.svgHandler.characters(), importSVG.svgHandler.endElement(), 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(), and TestSpreadsheet.SpreadsheetCases.testUnits().

key

Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.key

objname [1/2]

string Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.objname = ''

static

Referenced by Mod.Show.SceneDetails.Pickability.Pickability.apply_data(), Mod.Show.SceneDetails.VProperty.VProperty.apply_data(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.apply_data(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.scene_value(), Mod.Show.SceneDetails.Pickability.Pickability.scene_value(), Mod.Show.SceneDetails.VProperty.VProperty.scene_value(), and Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.val().

objname [2/2]

Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.objname

Referenced by Mod.Show.SceneDetails.Pickability.Pickability.apply_data(), Mod.Show.SceneDetails.VProperty.VProperty.apply_data(), Mod.Show.SceneDetails.VProperty.VProperty.scene_value(), and Mod.Show.SceneDetails.Pickability.Pickability.scene_value().

propname

string Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.propname = ''

static

Referenced by Mod.Show.SceneDetails.VProperty.VProperty.apply_data(), and Mod.Show.SceneDetails.VProperty.VProperty.scene_value().

---

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

• src/Mod/Show/SceneDetails/ObjectClipPlane.py