SectionViewBuilder Class¶

class NXOpen.Features.ShipDesign.SectionViewBuilder¶

Bases: NXOpen.Builder

This builder allows you to define the section view information for ship drawing.

It represents NXOpen.Features.ShipDesign.SectionViewBuilder To create a new instance of this class, use NXOpen.Features.ShipDesign.SectionDrawingBuilder.CreateSectionViewBuilder

Default values.

Property	Value
PlaneType	X
SectionRule	ByRule

New in version NX10.0.0.

Properties¶

Property	Description
AdditionalStructures	Returns the additional structures to be sectioned.
DrawingName	Returns or sets the drawing name
DrawingTemplate	Returns the drawing template builder, which represents a `NXOpen.Features.ShipDesign.DrawingTemplateBuilder`.
FlipViewDirection	Returns or sets the option to specify whether to flip the view direction or not
HiddenObjects	Returns the hidden object
Offset	Returns or sets the offset value
PlaneType	Returns or sets the frame type
SectionPlane	Returns or sets the section plane
SectionPlaneName	Returns or sets the section plane name
SectionRule	Returns or sets the section rule
SelectFrame	Returns the select frame
Tag	Returns the Tag for this object.

Methods¶

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
GetViewDirection	Gets the view direction @return
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

SectionViewBuilderDirectionOptions Enumeration	Settings to indicate the view direction
SectionViewBuilderPlaneTypes Enumeration	Settings to indicate the plane type
SectionViewBuilderSectionRuleOptions Enumeration	Settings to indicate the section rule

Property Detail¶

AdditionalStructures¶

SectionViewBuilder.AdditionalStructures¶

Returns the additional structures to be sectioned.

-------------------------------------

Getter Method

Signature AdditionalStructures()

Returns:
Return type:	`NXOpen.SelectNXObjectList`

New in version NX10.0.0.

License requirements: None.

DrawingName¶

SectionViewBuilder.DrawingName¶

Returns or sets the drawing name

-------------------------------------

Getter Method

Signature DrawingName()

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DrawingName(drawingName)

Parameters:	drawingName (str) –

New in version NX10.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

DrawingTemplate¶

SectionViewBuilder.DrawingTemplate¶

Returns the drawing template builder, which represents a NXOpen.Features.ShipDesign.DrawingTemplateBuilder.

-------------------------------------

Getter Method

Signature DrawingTemplate()

Returns:
Return type:	`NXOpen.Features.ShipDesign.DrawingTemplateBuilder`

New in version NX10.0.0.

License requirements: None.

FlipViewDirection¶

SectionViewBuilder.FlipViewDirection¶

Returns or sets the option to specify whether to flip the view direction or not

-------------------------------------

Getter Method

Signature FlipViewDirection()

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FlipViewDirection(flipViewDirection)

Parameters:	flipViewDirection (bool) –

New in version NX10.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

HiddenObjects¶

SectionViewBuilder.HiddenObjects¶

Returns the hidden object

-------------------------------------

Getter Method

Signature HiddenObjects()

Returns:
Return type:	`NXOpen.SelectNXObjectList`

New in version NX10.0.0.

License requirements: None.

Offset¶

SectionViewBuilder.Offset¶

Returns or sets the offset value

-------------------------------------

Getter Method

Signature Offset()

Returns:
Return type:	float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Offset(offset)

Parameters:	offset (float) –

New in version NX10.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

PlaneType¶

SectionViewBuilder.PlaneType¶

Returns or sets the frame type

-------------------------------------

Getter Method

Signature PlaneType()

Returns:
Return type:	`NXOpen.Features.ShipDesign.SectionViewBuilderPlaneTypes`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneType(frameType)

Parameters:	frameType (`NXOpen.Features.ShipDesign.SectionViewBuilderPlaneTypes`) –

New in version NX10.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

SectionPlane¶

SectionViewBuilder.SectionPlane¶

Returns or sets the section plane

-------------------------------------

Getter Method

Signature SectionPlane()

Returns:
Return type:	`NXOpen.Plane`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SectionPlane(sectionPlane)

Parameters:	sectionPlane (`NXOpen.Plane`) –

New in version NX10.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

SectionPlaneName¶

SectionViewBuilder.SectionPlaneName¶

Returns or sets the section plane name

-------------------------------------

Getter Method

Signature SectionPlaneName()

Returns:
Return type:	str

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SectionPlaneName(sectionPlaneName)

Parameters:	sectionPlaneName (str) –

New in version NX10.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

SectionRule¶

SectionViewBuilder.SectionRule¶

Returns or sets the section rule

-------------------------------------

Getter Method

Signature SectionRule()

Returns:
Return type:	`NXOpen.Features.ShipDesign.SectionViewBuilderSectionRuleOptions`

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SectionRule(sectionRule)

Parameters:	sectionRule (`NXOpen.Features.ShipDesign.SectionViewBuilderSectionRuleOptions`) –

New in version NX10.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

SelectFrame¶

SectionViewBuilder.SelectFrame¶

Returns the select frame

-------------------------------------

Getter Method

Signature SelectFrame()

Returns:
Return type:	`NXOpen.SelectDatumPlaneList`

New in version NX10.0.0.

License requirements: None.

Method Detail¶

GetViewDirection¶

SectionViewBuilder.GetViewDirection¶

Gets the view direction

Signature GetViewDirection()

Returns:
Return type:	`NXOpen.Features.ShipDesign.SectionViewBuilderDirectionOptions`

New in version NX10.0.0.

License requirements: None.

Validate¶

SectionViewBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.