FreeCAD: shipOutlineDraw.Preview.Preview Class Reference

Public Member Functions
def	clean (self)

def	reinit (self)

def	update (self, L, B, T, sectionsL, sectionsB, sectionsT, shape)

Public Attributes
	obj

Member Function Documentation

◆ clean()

def shipOutlineDraw.Preview.Preview.clean ( self )

Erase all the annotations from the screen.

References shipOutlineDraw.Preview.Preview.obj, shipAreasCurve.Preview.Preview.obj, PathScripts.PathDressupPathBoundaryGui.TaskPanel.obj, femtaskpanels.task_element_rotation1D._TaskPanel.obj, femtaskpanels.task_mesh_boundarylayer._TaskPanel.obj, femtaskpanels.task_mesh_group._TaskPanel.obj, femtaskpanels.task_mesh_region._TaskPanel.obj, MaterialEditor.MaterialEditor.obj, femtaskpanels.task_element_geometry2D._TaskPanel.obj, femtaskpanels.task_constraint_tie._TaskPanel.obj, femtaskpanels.task_element_geometry1D._TaskPanel.obj, PathScripts.PathIconViewProvider.ViewProvider.obj, PathCommands._CommandSelectLoop.obj, femtaskpanels.task_element_fluid1D._TaskPanel.obj, ReenGui::PoissonWidget::Private.obj, PathScripts.PathDressupRampEntry.ObjectDressup.obj, femtaskpanels.task_material_reinforced._TaskPanel.obj, PathScripts.PathToolBitGui.ViewProvider.obj, PathScripts.PathDressupPathBoundary.DressupPathBoundary.obj, PathScripts.PathDressupTagGui.PathDressupTagTaskPanel.obj, femtaskpanels.task_material_common._TaskPanel.obj, ReenGui::FitBSplineSurfaceWidget::Private.obj, PathScripts.PathPocketShapeGui._Extension.obj, PathScripts.PathDressupLeadInOut.ObjectDressup.obj, PathScripts.PathGetPoint.TaskPanel.obj, PathScripts.PathSetupSheetGui.ViewProvider.obj, draftguitools.gui_lines.Line.obj, Gui::ActiveObjectList::ObjectInfo.obj, draftguitools.gui_wire2spline.WireToBSpline.obj, PathScripts.PathSurfaceSupport.PathGeometryGenerator.obj, Sandbox::CustomAddObjectEvent.obj, Sandbox::Callable< T, method >.obj, ExpressionCompleterModel::Info.obj, PathScripts.PathSetupSheet.SetupSheet.obj, Import::ImportOCAF2::Info.obj, PartGui::FaceColors::Private.obj, PathScripts.PathJob.ObjectJob.obj, PathScripts.PathGui.QuantitySpinBox.obj, Sandbox::CallableWithArgs< T, Arg, method >.obj, draftguitools.gui_trimex.Trimex.obj, PathScripts.PathJobGui.ViewProvider.obj, PathScripts.PathToolBitGui.TaskPanel.obj, Sandbox::DocumentObjectProtector.obj, PathScripts.PathDressupTag.ObjectDressup.obj, PathScripts.PathPocketShape.Extension.obj, Mod.PartDesign.InvoluteGearFeature._InvoluteGearTaskPanel.obj, draftguitools.gui_base_original.DraftTool.obj, PathScripts.PathDressupAxisMap.ViewProviderDressup.obj, PathScripts.PathSetupSheetGui.OpTaskPanel.obj, Mod.PartDesign.SprocketFeature.SprocketTaskPanel.obj, PathScripts.PathToolBit.ToolBit.obj, AttachmentEditor.TaskAttachmentEditor.AttachmentEditorTaskPanel.obj, Sandbox::CustomPurgeEvent.obj, App::Origin::OriginExtension.obj, PathScripts.PathToolControllerGui.ToolControllerEditor.obj, MeshPartGui::ShapeInfo.obj, PathScripts.PathDressupZCorrect.TaskPanel.obj, PathScripts.PathDressupPathBoundaryGui.DressupPathBoundaryViewProvider.obj, PathScripts.PathOpGui.TaskPanelPage.obj, PartGui::DlgFilletEdges::Private::SelectionObjectCompare.obj, draftguitools.gui_edit.Edit.obj, Base::ObjectStatusLocker< Status, Object >.obj, PathScripts.PathSetupSheetGui.OpsDefaultEditor.obj, PathScripts.PathToolControllerGui.TaskPanel.obj, PathScripts.PathDressupZCorrect.ViewProviderDressup.obj, PathScripts.PathJobGui.StockEdit.obj, PathScripts.PathSetupSheetGui.GlobalEditor.obj, PathScripts.PathDressupDogbone.Bone.obj, PathScripts.PathToolControllerGui.DlgToolControllerEdit.obj, Info.obj, PathScripts.PathDressupTagGui.PathDressupTagViewProvider.obj, PathScripts.PathSetupSheetGui.TaskPanel.obj, ArchProfile.ProfileTaskPanel.obj, ArchSchedule.ArchScheduleTaskPanel.obj, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.obj, PathScripts.PathDressupLeadInOut.ViewProviderDressup.obj, ArchMaterial._ArchMaterialTaskPanel.obj, PathScripts.PathDressupHoldingTags.PathData.obj, PathScripts.PathJobGui.TaskPanel.obj, ArchReference.ArchReferenceTaskPanel.obj, PathScripts.PathDressupRampEntry.ViewProviderDressup.obj, ArchAxis._AxisTaskPanel.obj, ArchMaterial._ArchMultiMaterialTaskPanel.obj, PathScripts.PathDressupHoldingTags.ObjectTagDressup.obj, ArchRoof._RoofTaskPanel.obj, PathScripts.PathDressupDogbone.TaskPanel.obj, ArchAxis.AxisSystemTaskPanel.obj, PathScripts.PathOpGui.TaskPanel.obj, PathScripts.PathDressupDogbone.ViewProviderDressup.obj, UpdateLabelExpressionVisitor.obj, ArchWindow._ArchWindowTaskPanel.obj, ArchSectionPlane.SectionPlaneTaskPanel.obj, ArchAxis.ArchGridTaskPanel.obj, ArchPanel.SheetTaskPanel.obj, ItemInfo.obj, ItemInfo2.obj, ArchComponent.ComponentTaskPanel.obj, and DraftGui.FacebinderTaskPanel.obj.

Referenced by shipOutlineDraw.Preview.Preview.reinit(), and shipOutlineDraw.Preview.Preview.update().

◆ reinit()

def shipOutlineDraw.Preview.Preview.reinit ( self )

Reinitializate the drawer.

References shipAreasCurve.Preview.Preview.clean(), shipCreateShip.Preview.Preview.clean(), shipOutlineDraw.Preview.Preview.clean(), and Path::Area.clean().

◆ update()

def shipOutlineDraw.Preview.Preview.update	(		self,
			L,
			B,
			T,
			sectionsL,
			sectionsB,
			sectionsT,
			shape
	)

Update the 3D view annotations.
@param L Ship Lpp.
@param B Ship beam.
@param T Ship draft.
@param sectionsL Transversal sections.
@param sectionsB Longitudinal sections.
@param sectionsT Water lines.
@param shape Ship surfaces shell
@return Sections object. None if errors happens.

References shipAreasCurve.Preview.Preview.clean(), shipCreateShip.Preview.Preview.clean(), shipOutlineDraw.Preview.Preview.clean(), Path::Area.clean(), shipOutlineDraw.Preview.Preview.obj, shipAreasCurve.Preview.Preview.obj, PathScripts.PathDressupPathBoundaryGui.TaskPanel.obj, femtaskpanels.task_element_geometry2D._TaskPanel.obj, femtaskpanels.task_element_rotation1D._TaskPanel.obj, femtaskpanels.task_mesh_boundarylayer._TaskPanel.obj, femtaskpanels.task_mesh_group._TaskPanel.obj, femtaskpanels.task_mesh_region._TaskPanel.obj, MaterialEditor.MaterialEditor.obj, femtaskpanels.task_constraint_tie._TaskPanel.obj, femtaskpanels.task_element_geometry1D._TaskPanel.obj, femtaskpanels.task_element_fluid1D._TaskPanel.obj, PathScripts.PathIconViewProvider.ViewProvider.obj, PathCommands._CommandSelectLoop.obj, ReenGui::PoissonWidget::Private.obj, PathScripts.PathDressupRampEntry.ObjectDressup.obj, femtaskpanels.task_material_reinforced._TaskPanel.obj, PathScripts.PathDressupTagGui.PathDressupTagTaskPanel.obj, PathScripts.PathToolBitGui.ViewProvider.obj, PathScripts.PathDressupPathBoundary.DressupPathBoundary.obj, femtaskpanels.task_material_common._TaskPanel.obj, ReenGui::FitBSplineSurfaceWidget::Private.obj, PathScripts.PathPocketShapeGui._Extension.obj, PathScripts.PathDressupLeadInOut.ObjectDressup.obj, PathScripts.PathGetPoint.TaskPanel.obj, PathScripts.PathSetupSheetGui.ViewProvider.obj, draftguitools.gui_lines.Line.obj, Gui::ActiveObjectList::ObjectInfo.obj, draftguitools.gui_wire2spline.WireToBSpline.obj, PathScripts.PathSurfaceSupport.PathGeometryGenerator.obj, Sandbox::CustomAddObjectEvent.obj, Sandbox::Callable< T, method >.obj, ExpressionCompleterModel::Info.obj, PathScripts.PathSetupSheet.SetupSheet.obj, Import::ImportOCAF2::Info.obj, PartGui::FaceColors::Private.obj, PathScripts.PathJob.ObjectJob.obj, PathScripts.PathGui.QuantitySpinBox.obj, Sandbox::CallableWithArgs< T, Arg, method >.obj, draftguitools.gui_trimex.Trimex.obj, PathScripts.PathJobGui.ViewProvider.obj, PathScripts.PathToolBitGui.TaskPanel.obj, Sandbox::DocumentObjectProtector.obj, PathScripts.PathDressupTag.ObjectDressup.obj, PathScripts.PathPocketShape.Extension.obj, Mod.PartDesign.InvoluteGearFeature._InvoluteGearTaskPanel.obj, draftguitools.gui_base_original.DraftTool.obj, PathScripts.PathDressupAxisMap.ViewProviderDressup.obj, PathScripts.PathSetupSheetGui.OpTaskPanel.obj, Mod.PartDesign.SprocketFeature.SprocketTaskPanel.obj, PathScripts.PathToolBit.ToolBit.obj, AttachmentEditor.TaskAttachmentEditor.AttachmentEditorTaskPanel.obj, Sandbox::CustomPurgeEvent.obj, App::Origin::OriginExtension.obj, PathScripts.PathToolControllerGui.ToolControllerEditor.obj, MeshPartGui::ShapeInfo.obj, PathScripts.PathDressupZCorrect.TaskPanel.obj, PathScripts.PathDressupPathBoundaryGui.DressupPathBoundaryViewProvider.obj, PathScripts.PathOpGui.TaskPanelPage.obj, PartGui::DlgFilletEdges::Private::SelectionObjectCompare.obj, draftguitools.gui_edit.Edit.obj, Base::ObjectStatusLocker< Status, Object >.obj, PathScripts.PathSetupSheetGui.OpsDefaultEditor.obj, PathScripts.PathToolControllerGui.TaskPanel.obj, PathScripts.PathDressupZCorrect.ViewProviderDressup.obj, PathScripts.PathJobGui.StockEdit.obj, PathScripts.PathSetupSheetGui.GlobalEditor.obj, PathScripts.PathDressupDogbone.Bone.obj, PathScripts.PathToolControllerGui.DlgToolControllerEdit.obj, Info.obj, PathScripts.PathDressupTagGui.PathDressupTagViewProvider.obj, PathScripts.PathSetupSheetGui.TaskPanel.obj, ArchProfile.ProfileTaskPanel.obj, ArchSchedule.ArchScheduleTaskPanel.obj, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.obj, PathScripts.PathDressupLeadInOut.ViewProviderDressup.obj, ArchMaterial._ArchMaterialTaskPanel.obj, PathScripts.PathDressupHoldingTags.PathData.obj, PathScripts.PathJobGui.TaskPanel.obj, ArchReference.ArchReferenceTaskPanel.obj, PathScripts.PathDressupRampEntry.ViewProviderDressup.obj, ArchAxis._AxisTaskPanel.obj, ArchMaterial._ArchMultiMaterialTaskPanel.obj, PathScripts.PathDressupHoldingTags.ObjectTagDressup.obj, ArchRoof._RoofTaskPanel.obj, PathScripts.PathDressupDogbone.TaskPanel.obj, ArchAxis.AxisSystemTaskPanel.obj, PathScripts.PathOpGui.TaskPanel.obj, PathScripts.PathDressupDogbone.ViewProviderDressup.obj, UpdateLabelExpressionVisitor.obj, ArchWindow._ArchWindowTaskPanel.obj, ArchSectionPlane.SectionPlaneTaskPanel.obj, ArchAxis.ArchGridTaskPanel.obj, ArchPanel.SheetTaskPanel.obj, ItemInfo.obj, ItemInfo2.obj, ArchComponent.ComponentTaskPanel.obj, and DraftGui.FacebinderTaskPanel.obj.

Referenced by Spreadsheet_legacy.SpreadsheetView.changeCell(), ArchAxis.CommandArchGrid.IsActive(), and Spreadsheet_legacy.SpreadsheetView.recompute().

Member Data Documentation

◆ obj

shipOutlineDraw.Preview.Preview.obj

Referenced by shipOutlineDraw.TaskPanel.TaskPanel.accept(), Texture.ViewProviderTexture.claimChildren(), shipOutlineDraw.Preview.Preview.clean(), shipOutlineDraw.TaskPanel.TaskPanel.createPreview(), ArchAxis.CommandArchGrid.IsActive(), shipOutlineDraw.TaskPanel.TaskPanel.onTableItem(), ArchMaterial.MultiMaterialDelegate.setModelData(), shipOutlineDraw.TaskPanel.TaskPanel.setSectionType(), and shipOutlineDraw.Preview.Preview.update().

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

src/Mod/Ship/shipOutlineDraw/Preview.py