DynamicSectionBuilder Class¶
-
class
NXOpen.Display.
DynamicSectionBuilder
¶ Bases:
NXOpen.Builder
Represents a Dynamic Section Builder used for creating sections.
The dynamic sectioning is performed on a displayable part that is displayed in the modeling work view.It is possible to specify the view after creating the builder. However, the specified view must be modeling work view. This operation is meant to be performed in an interactive mode with visual feedback.
**Builder Creation:</b>
The dynamic section builder can be used to create new dynamic section objects OR to edit an existing section object.
See
Display.DynamicSectionCollection.CreateSectionBuilder
When a view is specified during the builder creation, the dynamic section object will be activated in the view. When the dynamic section object is activated in the view, view clipping and capping is enabled. However, it is not necessary to specify the view.
There are three different types of sections that are currently being supported.
- One Plane Section
- Two Parallel Planes Section
- Box Section
User can switch between these types at any time.
**Assembly and Modeling Operations</b>
- Create section curves by intersecting all clipping planes
- with all bodies in the scene
- Create a datum plane from the active section plane.
- Load components that are near or intersecting with the active
section plane.
All the APIs accept geometric data such as plane origin, plane normal in the absolute coordinate system.
**Saving changes</b>
Builder.Commit
method will activate the section object in the modeling view. It returns the dynamic section object tag.**Section Plane Families:</b>
An important issue with dynamic sectioning is the ability to easily define a group of related cross-section planes. A group of related cross-section planes will be known as a <tt>Plane Family</tt>. An important idea in understanding a plane family is the concept of a defining or a <tt>Base Plane</tt>. The base plane of the plane family is the starting point (i.e. plane) for the plane family. All planes in the family are related by an offset to the base plane. There are two types of plane families:
- Linear
- Axi-Symmetric
<tt>Linear Plane Family</tt>
A linear plane family is defined by an infinite group of parallel planes. All of the planes in a linear family are parallel to its base plane (i.e. along the base plane normal at some linear offset value). This is illustrated below with a base plane and three parallel planes to it that are members of the plane family.
Base Plane
<code> | | | | | | | | | | | | ==<ja_gt> Nomal to all planes. | | | | | | | | </code>
<tt>Axi-Symmetric Plane Family</tt>
An axi-symmetric plane family is defined by rotating the base plane about one of the three primary axes. There are an infinite number of planes in an axi-symmetric plane family similar to a linear plane family. This is illustrated below with a base plane and three planes rotated about the z-axis.
<code>
| / | / | / |/____ Base Plane </code>
**Switching between plane families</b>
Methods defining a new linear family
Display.DynamicSectionBuilder.AlternatePlane
Display.DynamicSectionBuilder.PlaneX
Display.DynamicSectionBuilder.PlaneY
Display.DynamicSectionBuilder.PlaneZ
Display.DynamicSectionBuilder.SetNormal
Display.DynamicSectionBuilder.SetOffset
Display.DynamicSectionBuilder.SetOffsetByPoint
Display.DynamicSectionBuilder.SetOrigin
Display.DynamicSectionBuilder.SetPlane
Following methods define a new axi-symmetric family
Display.DynamicSectionBuilder.SetRotationAngle
Display.DynamicSectionBuilder.SetRotationMatrix
**Transition between plane families</b>
When a method defining a new linear family is invoked, then if
- the current plane is in a linear family, it will stay in the family.
- the current plane is in a axi-symmetric family, it becomes the base
plane of the linear family.
The same thing happens when a method defining a new axi-symmetric plane is invoked.
**Examples:</b>
<tt>1. Linear Family</tt>
Goal: User wants to create a series of sections along X axis.
API sequence:
<code> planeX - Create a plane with base plane at X = 0 See Display.DynamicSectionBuilder.PlaneX:py:meth:Display.DynamicSectionBuilder.PlaneX SetOffset( 50 ) - Plane at X = 50 SetOffset( 100 ) - Plane at X = 100 SetOffset( 0 ) - Plane at X = 0 </code>
<tt>2. Axi-symmetric Family</tt>
Goal: User wants to create a series of sections by planes rotated around X axis of the section plane.
API sequence:
<code> SetRotation( X, 45 ) - The current plane becomes base plane. Then the plane rotated around X axis by 45 degrees. SetRotation( X, 90 ) - Plane rotated around X axis by 90 degrees. SetRotation( X, 90 ) - Plane rotated around X axis by 0 degrees. Back to original position. </code>
To create a new instance of this class, use
NXOpen.Display.DynamicSectionCollection.CreateSectionBuilder
Default values.
Property Value BoxExtentDelayUpdate false CapColorOption Any ClipType Section CurveColorOption Any LayerSettings.LayerOption Work LockPlanes true ShowCap true ShowClip true ShowCurves (deprecated) false ShowGrid false ShowInterference false ShowViewer false Type OnePlane New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
BoxExtentDelayUpdate | Returns or sets the delay box extent update. |
BoxExtentMargin | Returns or sets the margin for box section extents |
BoxExtentObjects | Returns the objects that define the extents for box section. |
BoxExtentSupported | Returns the box extent support. |
CapColor | Returns or sets the cap color. |
CapColorOption | Returns or sets the cap color option |
ClipType | Returns or sets the clip type |
CsysType | Returns or sets the coordinate system used for creating section plane along X, Y or Z principal planes. |
CurveColor | Returns or sets the curve color. |
CurveColorOption | Returns or sets the curve color option |
DeferCurveUpdate | Returns or sets the defer curve update property. |
InterferenceColor | Returns or sets the interference color. |
LayerSettings | Returns the layer settings builder |
LockPlanes | Returns or sets the lock planes flag. |
NumberInSeries | Returns or sets the number of requested section planes in the current section series. |
ReverseSeries | Returns or sets the reverse series flag |
SeriesSpacing | Returns or sets the section plane spacing in the current section series. |
ShowCap | Returns or sets the cap on off flag |
ShowClip | Returns or sets the clip on off flag |
ShowCurves | Returns or sets the curve on off flag. |
ShowGrid | Returns or sets the show grid display flag |
ShowInterference | Returns or sets the interference on off flag. |
ShowViewer | Returns or sets the 2D viewer display flag |
Tag | Returns the Tag for this object. |
Type | Returns or sets the section type |
View | Returns or sets the modeling view in which section object edits are being done. |
Methods¶
Method | Description |
---|---|
AlternatePlane | Cycle through planes that are 90 degrees aligned to the current section plane. |
Commit | Commits any edits that have been applied to the builder. |
CreateDatumPlane | Creates a datum plane from the active section plane. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
EditView | Edits the section object in the modeling view. |
GetActivePlane | Gets the active plane in the section. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetGridSettings | Creates a grid settings builder from the active section plane. |
GetName | Gets the section name. |
GetNormal | Gets the normal of the section plane @return Section plane normal |
GetObject | Returns the object currently being edited by this builder. |
GetOffset | Gets the the plane offset. |
GetOffsetLimits | Gets minimum and maximum offset limits. |
GetOrigin | Gets the section origin. |
GetPlaneThickness | Gets the thickness between active plane pair. |
GetRotationAngle | Gets rotation angle for specified axis. |
GetRotationMatrix | Gets the section rotation matrix @return Rotation matrix |
IsAssociativitySupported | Determines if an associative section plane is supported. |
LoadAllIntersecting | Loads all components that intersect the current section plane. |
LoadNearIntersecting | Loads components that intersect the current section plane and are near the section plane origin. |
OffsetOriginInPlane | Offsets section origin within current section plane. |
PlaneX | Creates a plane along X direction. |
PlaneY | Creates a plane along Y direction. |
PlaneZ | Creates a plane along Z direction. |
RestoreView | Restores the section to the saved section in the view database. |
ReverseDirection | Reverses the plane direction. |
SaveCurves | Creates curves by intersecting all clipping planes of the section with all visible bodies in the scene and adds them to the group created with the specified name. |
SetActivePlane | Sets the active plane in the section |
SetAssociativePlane | Makes dynamic section associative to the specified plane The plane must be a smart plane; otherwise an error will be reported. |
SetDefaultPlane | Set current section plane to its default definition. |
SetDefaults | Set current section to the default values. |
SetName | Sets the section name. |
SetNormal | Sets the normal of the section plane |
SetOffset | Sets the the plane offset. |
SetOffsetByPoint | This method offsets the active clipping plane such that the plane passes through the specified point. |
SetOrigin | Sets the section origin. |
SetPlane | Sets a section plane to be the specified plane The plane is created at the specified origin with the specified rotation matrix. |
SetPlaneThickness | Sets the thickness between active plane pair. |
SetRotationAngle | Rotates the section about specified axis by the specified angle. |
SetRotationMatrix | Sets the section rotation matrix |
ShowCurvePreview | Show/hide curve preview. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
ShowSectionCurves | Shows the section curves in the view associated with the builder. |
UpdateBoxExtents | Update box section display by recomputing the box extents if necessary. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
BoxExtentDelayUpdate¶
-
DynamicSectionBuilder.
BoxExtentDelayUpdate
¶ Returns or sets the delay box extent update.
This determines if the box section extent updates are delayed when selection list is modified (see
Display.DynamicSectionBuilder.BoxExtentObjects
).If true then use
Display.DynamicSectionBuilder.UpdateBoxExtents
to update the box section. If false then update happens immediately.Use
Display.DynamicSectionBuilder.BoxExtentSupported
to determine if extent construction is supported before querying or setting extent attributes.-------------------------------------
Getter Method
Signature
BoxExtentDelayUpdate()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoxExtentDelayUpdate(delayUpdate)
Parameters: delayUpdate (bool) – New in version NX10.0.0.
License requirements: None.
BoxExtentMargin¶
-
DynamicSectionBuilder.
BoxExtentMargin
¶ Returns or sets the margin for box section extents
Use
Display.DynamicSectionBuilder.BoxExtentSupported
to determine if extent construction is supported before querying or setting extent attributes.-------------------------------------
Getter Method
Signature
BoxExtentMargin()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoxExtentMargin(margin)
Parameters: margin (float) – New in version NX10.0.0.
License requirements: None.
BoxExtentObjects¶
-
DynamicSectionBuilder.
BoxExtentObjects
¶ Returns the objects that define the extents for box section.
Absence of the object list indicates that the extent construction is not supported.
-------------------------------------
Getter Method
Signature
BoxExtentObjects()
Returns: Return type: NXOpen.SelectINXObjectList
New in version NX10.0.0.
License requirements: None.
BoxExtentSupported¶
-
DynamicSectionBuilder.
BoxExtentSupported
¶ Returns the box extent support.
This is used to determine if the box extent construction is supported. Any box extent related APIs will not function when the extent construction is not supported.
-------------------------------------
Getter Method
Signature
BoxExtentSupported()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
CapColor¶
-
DynamicSectionBuilder.
CapColor
¶ Returns or sets the cap color.
Used when cap color type is
Display.DynamicSectionTypesCapColorOption.Any
-------------------------------------
Getter Method
Signature
CapColor()
Returns: Return type: Id New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CapColor(capColor)
Parameters: capColor (Id) – New in version NX5.0.0.
License requirements: None.
CapColorOption¶
-
DynamicSectionBuilder.
CapColorOption
¶ Returns or sets the cap color option
-------------------------------------
Getter Method
Signature
CapColorOption()
Returns: Return type: NXOpen.Display.DynamicSectionTypesCapColorOption
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CapColorOption(capColorOption)
Parameters: capColorOption ( NXOpen.Display.DynamicSectionTypesCapColorOption
) –New in version NX5.0.0.
License requirements: None.
ClipType¶
-
DynamicSectionBuilder.
ClipType
¶ Returns or sets the clip type
-------------------------------------
Getter Method
Signature
ClipType()
Returns: Return type: NXOpen.Display.DynamicSectionTypesClip
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ClipType(clipType)
Parameters: clipType ( NXOpen.Display.DynamicSectionTypesClip
) –New in version NX5.0.0.
License requirements: None.
CsysType¶
-
DynamicSectionBuilder.
CsysType
¶ Returns or sets the coordinate system used for creating section plane along X, Y or Z principal planes.
-------------------------------------
Getter Method
Signature
CsysType()
Returns: Return type: NXOpen.Display.DynamicSectionTypesCoordinateSystem
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CsysType(csys)
Parameters: csys ( NXOpen.Display.DynamicSectionTypesCoordinateSystem
) –New in version NX5.0.0.
License requirements: None.
CurveColor¶
-
DynamicSectionBuilder.
CurveColor
¶ Returns or sets the curve color.
Used when the curve color option is set to
Display.DynamicSectionTypesCurveColorOption.Any
.-------------------------------------
Getter Method
Signature
CurveColor()
Returns: Return type: Id New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurveColor(curveColor)
Parameters: curveColor (Id) – New in version NX5.0.0.
License requirements: None.
CurveColorOption¶
-
DynamicSectionBuilder.
CurveColorOption
¶ Returns or sets the curve color option
-------------------------------------
Getter Method
Signature
CurveColorOption()
Returns: Return type: NXOpen.Display.DynamicSectionTypesCurveColorOption
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurveColorOption(curveColorOption)
Parameters: curveColorOption ( NXOpen.Display.DynamicSectionTypesCurveColorOption
) –New in version NX5.0.0.
License requirements: None.
DeferCurveUpdate¶
-
DynamicSectionBuilder.
DeferCurveUpdate
¶ Returns or sets the defer curve update property.
This property can be used to reduce number of curve updates when performing a series of attribute changes on the dynamic section. After the changes are done, undefer the curve update. Undeferring will update the curves, if and only if, curve update is required based on the applied changes.
-------------------------------------
Getter Method
Signature
DeferCurveUpdate()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DeferCurveUpdate(deferCurveUpdate)
Parameters: deferCurveUpdate (bool) – New in version NX8.0.0.
License requirements: None.
InterferenceColor¶
-
DynamicSectionBuilder.
InterferenceColor
¶ Returns or sets the interference color.
-------------------------------------
Getter Method
Signature
InterferenceColor()
Returns: Return type: Id New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InterferenceColor(interferenceColor)
Parameters: interferenceColor (Id) – New in version NX5.0.0.
License requirements: None.
LayerSettings¶
-
DynamicSectionBuilder.
LayerSettings
¶ Returns the layer settings builder
-------------------------------------
Getter Method
Signature
LayerSettings()
Returns: Return type: NXOpen.Display.LayerSettingsBuilder
New in version NX9.0.0.
License requirements: None.
LockPlanes¶
-
DynamicSectionBuilder.
LockPlanes
¶ Returns or sets the lock planes flag.
The planes can be locked in case of Two Parallel Planes and Box Section. When locked the planes will move together.
-------------------------------------
Getter Method
Signature
LockPlanes()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LockPlanes(lockPlanes)
Parameters: lockPlanes (bool) – New in version NX5.0.0.
License requirements: None.
NumberInSeries¶
-
DynamicSectionBuilder.
NumberInSeries
¶ Returns or sets the number of requested section planes in the current section series.
-------------------------------------
Getter Method
Signature
NumberInSeries()
Returns: Number of section requested (<ja_gt>= 1). Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberInSeries(numberSectionsRequested)
Parameters: numberSectionsRequested (int) – Number of section requested (<ja_gt>= 1). New in version NX6.0.0.
License requirements: None.
ReverseSeries¶
-
DynamicSectionBuilder.
ReverseSeries
¶ Returns or sets the reverse series flag
-------------------------------------
Getter Method
Signature
ReverseSeries()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseSeries(reverseSeries)
Parameters: reverseSeries (bool) – New in version NX6.0.0.
License requirements: None.
SeriesSpacing¶
-
DynamicSectionBuilder.
SeriesSpacing
¶ Returns or sets the section plane spacing in the current section series.
-------------------------------------
Getter Method
Signature
SeriesSpacing()
Returns: Distance between sections (<ja_gt>= 0.02). Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SeriesSpacing(sectionSpacing)
Parameters: sectionSpacing (float) – Distance between sections (<ja_gt>= 0.02). New in version NX6.0.0.
License requirements: None.
ShowCap¶
-
DynamicSectionBuilder.
ShowCap
¶ Returns or sets the cap on off flag
-------------------------------------
Getter Method
Signature
ShowCap()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowCap(showCap)
Parameters: showCap (bool) – New in version NX5.0.0.
License requirements: None.
ShowClip¶
-
DynamicSectionBuilder.
ShowClip
¶ Returns or sets the clip on off flag
-------------------------------------
Getter Method
Signature
ShowClip()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowClip(showClip)
Parameters: showClip (bool) – New in version NX5.0.0.
License requirements: None.
ShowCurves¶
-
DynamicSectionBuilder.
ShowCurves
¶ Returns or sets the curve on off flag.
When the dynamic section object is visible in the view, the curves from the section object are shown in that view.
-------------------------------------
Getter Method
Signature
ShowCurves()
Returns: Return type: bool New in version NX5.0.0.
Deprecated since version NX6.0.0: Use
ModelingView.IsDynamicSectionVisible
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
ShowCurves(showCurves)
Parameters: showCurves (bool) – New in version NX5.0.0.
Deprecated since version NX6.0.0: Use
ModelingView.SetDynamicSectionVisible
instead.License requirements: None.
ShowGrid¶
-
DynamicSectionBuilder.
ShowGrid
¶ Returns or sets the show grid display flag
-------------------------------------
Getter Method
Signature
ShowGrid()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowGrid(showGrid)
Parameters: showGrid (bool) – New in version NX6.0.0.
License requirements: None.
ShowInterference¶
-
DynamicSectionBuilder.
ShowInterference
¶ Returns or sets the interference on off flag.
-------------------------------------
Getter Method
Signature
ShowInterference()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowInterference(showInterference)
Parameters: showInterference (bool) – New in version NX5.0.0.
License requirements: None.
ShowViewer¶
-
DynamicSectionBuilder.
ShowViewer
¶ Returns or sets the 2D viewer display flag
-------------------------------------
Getter Method
Signature
ShowViewer()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowViewer(showViewer)
Parameters: showViewer (bool) – New in version NX6.0.0.
License requirements: None.
Type¶
-
DynamicSectionBuilder.
Type
¶ Returns or sets the section type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Display.DynamicSectionTypesType
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Display.DynamicSectionTypesType
) –New in version NX5.0.0.
License requirements: None.
View¶
-
DynamicSectionBuilder.
View
¶ Returns or sets the modeling view in which section object edits are being done.
Display.DynamicSectionBuilder.View
method is present for legacy reasons.Use
Display.DynamicSectionBuilder.EditView
instead.-------------------------------------
Getter Method
Signature
View()
Returns: Modeling view Return type: NXOpen.ModelingView
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
View(view)
Parameters: view ( NXOpen.ModelingView
) – Modeling viewNew in version NX5.0.0.
License requirements: None.
Method Detail¶
AlternatePlane¶
-
DynamicSectionBuilder.
AlternatePlane
¶ Cycle through planes that are 90 degrees aligned to the current section plane.
For example, for a XY plane with normal along positive Z axis, invoking this method will cycle through the planes in the following order. <code> - YZ plane with normal along X axis - XZ plane with normal along Y axis - XY plane with normal along Z axis </code>
The section offset and rotation matrix are updated.
Signature
AlternatePlane()
New in version NX5.0.0.
License requirements: None.
CreateDatumPlane¶
-
DynamicSectionBuilder.
CreateDatumPlane
¶ Creates a datum plane from the active section plane.
Signature
CreateDatumPlane()
Returns: Datum plane Return type: NXOpen.DatumPlane
New in version NX5.0.0.
License requirements: None.
EditView¶
-
DynamicSectionBuilder.
EditView
¶ Edits the section object in the modeling view.
The view being edited must be the modeling view. This is provided to handle scenarios when the working view is changed when sectioning is in progress. It is the responsibility of user to save pending changes using
Builder.Commit
method. Otherwise, any existing changes will be lost.Signature
EditView(view)
Parameters: view ( NXOpen.ModelingView
) – Modeling viewNew in version NX6.0.0.
License requirements: None.
GetActivePlane¶
-
DynamicSectionBuilder.
GetActivePlane
¶ Gets the active plane in the section.
- See
Display.DynamicSectionBuilder.SetActivePlane
- for details.
Signature
GetActivePlane()
Returns: a tuple Return type: A tuple consisting of (planeAxis, activePlane). planeAxis is a NXOpen.Display.DynamicSectionTypesAxis
. activePlane is aNXOpen.Display.DynamicSectionTypesActivePlane
.New in version NX5.0.0.
License requirements: None.
- See
GetGridSettings¶
-
DynamicSectionBuilder.
GetGridSettings
¶ Creates a grid settings builder from the active section plane.
Signature
GetGridSettings()
Returns: Return type: NXOpen.Display.PlaneGridBuilder
New in version NX6.0.0.
License requirements: None.
GetName¶
-
DynamicSectionBuilder.
GetName
¶ Gets the section name.
Caller is expected to free the memory.
Signature
GetName()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
GetNormal¶
-
DynamicSectionBuilder.
GetNormal
¶ Gets the normal of the section plane
Signature
GetNormal()
Returns: Section plane normal Return type: NXOpen.Vector3d
New in version NX5.0.0.
License requirements: None.
GetOffset¶
-
DynamicSectionBuilder.
GetOffset
¶ Gets the the plane offset.
Signature
GetOffset()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
GetOffsetLimits¶
-
DynamicSectionBuilder.
GetOffsetLimits
¶ Gets minimum and maximum offset limits.
Offset limits are dependent on the active section plane. They are determined based on the model bounding box and location of the active section plane.
Display.DynamicSectionBuilder.SetOffset
can specify offset outside the offset limits. In that case the offset limits are extended to include the specified offset.Signature
GetOffsetLimits()
Returns: a tuple Return type: A tuple consisting of (minimumOffset, maximumOffset). minimumOffset is a float. Minimum offset maximumOffset is a float. Minimum offset New in version NX5.0.0.
License requirements: None.
GetOrigin¶
-
DynamicSectionBuilder.
GetOrigin
¶ Gets the section origin.
Signature
GetOrigin()
Returns: Section origin Return type: NXOpen.Point3d
New in version NX5.0.0.
License requirements: None.
GetPlaneThickness¶
-
DynamicSectionBuilder.
GetPlaneThickness
¶ Gets the thickness between active plane pair.
This is valid when the section contains more than one clipping plane. When the section planes are locked, setting thickness will not alter the current thickness.
Signature
GetPlaneThickness()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
GetRotationAngle¶
-
DynamicSectionBuilder.
GetRotationAngle
¶ Gets rotation angle for specified axis.
Signature
GetRotationAngle(rotationAxis)
Parameters: rotationAxis ( NXOpen.Display.DynamicSectionTypesAxis
) –Returns: Rotation angle in degrees Return type: float New in version NX5.0.0.
License requirements: None.
GetRotationMatrix¶
-
DynamicSectionBuilder.
GetRotationMatrix
¶ Gets the section rotation matrix
Signature
GetRotationMatrix()
Returns: Rotation matrix Return type: NXOpen.Matrix3x3
New in version NX5.0.0.
License requirements: None.
IsAssociativitySupported¶
-
DynamicSectionBuilder.
IsAssociativitySupported
¶ Determines if an associative section plane is supported.
Signature
IsAssociativitySupported()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
LoadAllIntersecting¶
-
DynamicSectionBuilder.
LoadAllIntersecting
¶ Loads all components that intersect the current section plane.
Errors are reported by the part load status. Caller is expected to destroy the memory used by load status object.
Signature
LoadAllIntersecting()
Returns: a tuple Return type: A tuple consisting of (componentsLoaded, loadStatus). componentsLoaded is a bool. New component loaded flag loadStatus is a NXOpen.PartLoadStatus
. Errors occurred during loading of parts.New in version NX5.0.0.
License requirements: adv_assemblies (“ADVANCED ASSEMBLIES”)
LoadNearIntersecting¶
-
DynamicSectionBuilder.
LoadNearIntersecting
¶ Loads components that intersect the current section plane and are near the section plane origin.
The distance used for which components are “near” the section plane origin is determined internally. Errors are reported by the part load status. Caller is expected to destroy the memory used by load status object.
Signature
LoadNearIntersecting()
Returns: a tuple Return type: A tuple consisting of (componentsLoaded, loadStatus). componentsLoaded is a bool. New component loaded flag loadStatus is a NXOpen.PartLoadStatus
. Errors occurred during loading of parts.New in version NX5.0.0.
License requirements: adv_assemblies (“ADVANCED ASSEMBLIES”)
OffsetOriginInPlane¶
-
DynamicSectionBuilder.
OffsetOriginInPlane
¶ Offsets section origin within current section plane.
The section is moved to new location along in the section plane. The offsets are w.r.t. current origin along the X and Y axis of the section plane respectively.
Signature
OffsetOriginInPlane(xOffset, yOffset)
Parameters: - xOffset (float) – Delta X from the current position
- yOffset (float) – Delta Y from the current position
New in version NX5.0.0.
License requirements: None.
PlaneX¶
-
DynamicSectionBuilder.
PlaneX
¶ Creates a plane along X direction.
The plane is created with the base plane at the origin with normal along X axis of the coordinate system
Display.DynamicSectionBuilder.CsysType`
.The location of the plane depends on the bounding box of all parts displayed in the view. The plane is positioned at the center of the bounding box.
Section offset and rotation matrix are updated.
Section thickness is recomputed based on the bounding box.
Signature
PlaneX()
New in version NX5.0.0.
License requirements: None.
PlaneY¶
-
DynamicSectionBuilder.
PlaneY
¶ Creates a plane along Y direction.
The plane is created with the base plane at the origin with normal along Y axis of the coordinate system
Display.DynamicSectionBuilder.CsysType`
.The location of the plane depends on the bounding box of all parts displayed in the view. The plane is positioned at the center of the bounding box.
Section offset and rotation matrix are updated.
Section thickness is recomputed based on the bounding box.
Signature
PlaneY()
New in version NX5.0.0.
License requirements: None.
PlaneZ¶
-
DynamicSectionBuilder.
PlaneZ
¶ Creates a plane along Z direction.
The plane is created with the base plane at the origin with normal along Z axis of the coordinate system
Display.DynamicSectionBuilder.CsysType`
.The location of the plane depends on the bounding box of all parts displayed in the view. The plane is positioned at the center of the bounding box.
Section offset and rotation matrix are updated.
Section thickness is recomputed based on the bounding box.
Signature
PlaneZ()
New in version NX5.0.0.
License requirements: None.
RestoreView¶
-
DynamicSectionBuilder.
RestoreView
¶ Restores the section to the saved section in the view database.
Signature
RestoreView()
New in version NX5.0.0.
License requirements: None.
ReverseDirection¶
-
DynamicSectionBuilder.
ReverseDirection
¶ Reverses the plane direction.
This will flip the side of the model being clipped.
Section rotation matrix is updated.
Signature
ReverseDirection()
New in version NX5.0.0.
License requirements: None.
SaveCurves¶
-
DynamicSectionBuilder.
SaveCurves
¶ Creates curves by intersecting all clipping planes of the section with all visible bodies in the scene and adds them to the group created with the specified name.
The group is displayed in the part navigator. If the customer default “Load Solids/Sheets when Saving Section Curves” is enabled, then this will load exact solid/sheet bodies for the visible lightweight bodies intersecting the clipping planes. This may increase the time and memory used by the operation, but will ensure exact section curves.
Signature
SaveCurves(groupName)
Parameters: groupName (str) – Name of the group containing curves NOTE: The full Unicode character set is not supported for this parameter. New in version NX5.0.0.
License requirements: None.
SetActivePlane¶
-
DynamicSectionBuilder.
SetActivePlane
¶ Sets the active plane in the section
Single Plane:
There is no secondary plane. Only primary plane exists.
Two Parallel Plane Section:
Display.DynamicSectionTypesAxis.Z
is the active axis and primary/secondary plane can be activated.Box Section:
The active plane pair can be selected by specifying the planeAxis Given an axis, the primary/secondary planes can be activated.
E.g. To activate primary plane along the local X axis use
Display.DynamicSectionTypesAxis.X
andDisplay.DynamicSectionTypesActivePlane.Primary
.Signature
SetActivePlane(planeAxis, activePlane)
Parameters: - planeAxis (
NXOpen.Display.DynamicSectionTypesAxis
) – - activePlane (
NXOpen.Display.DynamicSectionTypesActivePlane
) –
New in version NX5.0.0.
License requirements: None.
- planeAxis (
SetAssociativePlane¶
-
DynamicSectionBuilder.
SetAssociativePlane
¶ Makes dynamic section associative to the specified plane The plane must be a smart plane; otherwise an error will be reported.
Associative plane can be specified only if the builder supports associativity (see
Display.DynamicSectionBuilder.IsAssociativitySupported
).Signature
SetAssociativePlane(planeTag)
Parameters: planeTag ( NXOpen.Plane
) – PlaneNew in version NX9.0.0.
License requirements: None.
SetDefaultPlane¶
-
DynamicSectionBuilder.
SetDefaultPlane
¶ Set current section plane to its default definition.
This will only modify section plane geometry.
Signature
SetDefaultPlane()
New in version NX5.0.0.
License requirements: None.
SetDefaults¶
-
DynamicSectionBuilder.
SetDefaults
¶ Set current section to the default values.
This will modify all section geometry as well as section attributes.
Signature
SetDefaults()
New in version NX5.0.0.
License requirements: None.
SetName¶
-
DynamicSectionBuilder.
SetName
¶ Sets the section name.
The specified name will be validated. A section is expected to have a unique name in a part. The name may be modified to make it unique within the part.
Signature
SetName(sectionName)
Parameters: sectionName (str) – Section name Returns: If specified name was modified to ensure uniqueness :rtype: bool
New in version NX6.0.0.
License requirements: None.
SetNormal¶
-
DynamicSectionBuilder.
SetNormal
¶ Sets the normal of the section plane
Section offset and rotation matrix are updated.
Signature
SetNormal(normal)
Parameters: normal ( NXOpen.Vector3d
) – Section plane normalNew in version NX5.0.0.
License requirements: None.
SetOffset¶
-
DynamicSectionBuilder.
SetOffset
¶ Sets the the plane offset.
When there are more than one clipping planes in the section, the active clipping plane will be not be allowed to cross-over the non-active clipping plane.
If
Display.DynamicSectionBuilder.LockPlanes`
is off, section thickness is updated.Signature
SetOffset(offset)
Parameters: offset (float) – Offset New in version NX5.0.0.
License requirements: None.
SetOffsetByPoint¶
-
DynamicSectionBuilder.
SetOffsetByPoint
¶ This method offsets the active clipping plane such that the plane passes through the specified point.
When there are more than one clipping planes in the section, the active clipping plane will be not be allowed to cross-over the non-active clipping plane.
See
Display.DynamicSectionBuilder.SetOffset
Signature
SetOffsetByPoint(point)
Parameters: point ( NXOpen.Point3d
) – Point in absolute coordinate system.New in version NX5.0.0.
License requirements: None.
SetOrigin¶
-
DynamicSectionBuilder.
SetOrigin
¶ Sets the section origin.
The section is moved to new location. It obeys the lock flag
Display.DynamicSectionBuilder.LockPlanes`
. if it is a multiple plane section.Section offset is updated.
Signature
SetOrigin(origin)
Parameters: origin ( NXOpen.Point3d
) – Section originNew in version NX5.0.0.
License requirements: None.
SetPlane¶
-
DynamicSectionBuilder.
SetPlane
¶ Sets a section plane to be the specified plane The plane is created at the specified origin with the specified rotation matrix.
The axis origin can be same as the plane origin. To defind a linear plane family from the absolute origin, define axis origin as {0, 0, 0}. The section offset will reflect the distance of the plane from the axis origin.
Section offset and rotation matrix are updated.
Signature
SetPlane(axisOrigin, origin, rotationMatrix)
Parameters: - axisOrigin (
NXOpen.Point3d
) – Axis origin - origin (
NXOpen.Point3d
) – Plane origin. - rotationMatrix (
NXOpen.Matrix3x3
) – Rotation matrix
New in version NX5.0.0.
License requirements: None.
- axisOrigin (
SetPlaneThickness¶
-
DynamicSectionBuilder.
SetPlaneThickness
¶ Sets the thickness between active plane pair.
This property is only available when the section contains more than one clipping plane. When the section planes are locked, setting thickness will not alter the current thickness.
Signature
SetPlaneThickness(planeThickness)
Parameters: planeThickness (float) – Active plane thickness New in version NX5.0.0.
License requirements: None.
SetRotationAngle¶
-
DynamicSectionBuilder.
SetRotationAngle
¶ Rotates the section about specified axis by the specified angle.
If a rotation already exists about the specified axis, then the section is rotated such that the total rotation angle is set to the specified angle. Rotation about only one axis is active at a time. <code> 1. Create plane with normal along Z.
2. Display.DynamicSectionBuilder.SetRotationAngle:py:meth:`Display.DynamicSectionBuilder.SetRotationAngle`( X, 30 ) Rotates plane around X axis by 30 degrees
3. Display.DynamicSectionBuilder.SetRotationAngle:py:meth:`Display.DynamicSectionBuilder.SetRotationAngle`( X, 45 ) Incremental rotation of 45 - 30 = 15 degrees. </code>
Section offset and rotation matrix are updated.
Signature
SetRotationAngle(rotationAxis, angle)
Parameters: - rotationAxis (
NXOpen.Display.DynamicSectionTypesAxis
) – - angle (float) – Rotation angle in degrees
New in version NX5.0.0.
License requirements: None.
- rotationAxis (
SetRotationMatrix¶
-
DynamicSectionBuilder.
SetRotationMatrix
¶ Sets the section rotation matrix
Specify
Display.DynamicSectionTypesAxis.None
if the axis about which rotation was performed is not known.Section offset and rotation matrix are updated.
Signature
SetRotationMatrix(rotationAxis, rotationMatrix)
Parameters: - rotationAxis (
NXOpen.Display.DynamicSectionTypesAxis
) – - rotationMatrix (
NXOpen.Matrix3x3
) – Rotation matrix
New in version NX5.0.0.
License requirements: None.
- rotationAxis (
ShowCurvePreview¶
-
DynamicSectionBuilder.
ShowCurvePreview
¶ Show/hide curve preview.
When editing a view section, curve preview can be shown while the editing is in progress. The preview is removed once the changes are committed on the builder or when the builder is destroyed.
Hiding preview will remove the section series preview too.
Signature
ShowCurvePreview(showCurvePreview)
Parameters: showCurvePreview (bool) – New in version NX10.0.0.
License requirements: None.
ShowSectionCurves¶
-
DynamicSectionBuilder.
ShowSectionCurves
¶ Shows the section curves in the view associated with the builder.
If no view is associated with the builder, then the curves are Shown in the current work view.
Signature
ShowSectionCurves(showCurves)
Parameters: showCurves (bool) – New in version NX7.5.0.
License requirements: None.
UpdateBoxExtents¶
-
DynamicSectionBuilder.
UpdateBoxExtents
¶ Update box section display by recomputing the box extents if necessary.
Use
Display.DynamicSectionBuilder.BoxExtentSupported
to determine if extent construction is supported before querying or setting extent attributes.Signature
UpdateBoxExtents()
New in version NX10.0.0.
License requirements: None.
Validate¶
-
DynamicSectionBuilder.
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.