WaveSketchBuilder Class

class NXOpen.Features.WaveSketchBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a WaveSketchBuilder.

To create a new instance of this class, use NXOpen.Features.FeatureCollection.CreateWaveSketchBuilder()

Default values.

Property	Value
Associative	True
DisplayReferenceGeometry	False
InheritDisplayProperties	False
ParentPart	OtherPart

New in version NX5.0.1.

Properties

Property	Description
Associative	Returns or sets the associative
DisplayReferenceGeometry	Returns or sets the setting that controls whether or not the reference geometry in the linked sketch are displayed
HideOriginal	Returns or sets the hide original option
InheritDisplayProperties	Returns or sets the inherit display property option
MakePositionIndependent	Returns or sets the make position independent option
ParentFeatureInternal	Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
ParentPart	Returns or sets the source part type
PatchSolutionFlag	Returns or sets the patch solution flag
PatchSurfaceFilename	Returns or sets the patch surface filename
Sketches	Returns the sketch to link
SourcePartOccurrence	Returns or sets the source part occurrence
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CommitCreateOnTheFly	Commits the feature and set create on the fly flag
CommitFeature	Commits the feature parameters and creates the feature
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.
GetFeature	Returns the feature currently being edited by this builder.
GetObject	Returns the object currently being edited by this builder.
GetProductInterfaceObjects	Gets selected product interface objects
GetSourcePartOccurrences	Gets source part occurrences
GetWaveLinkInformation	Prints wave browser type information about link
HideInternalParentFeatureAfterEdit	Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal	Set the parent features which would be internal or slaves to the feature being created or commited
SetProductInterfaceObjects	Sets selected product interface objects
SetSourcePartOccurrences	Sets source part occurrences
ShowInternalParentFeatureForEdit	Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal	Set the internal parent feature of the feature being edited to external
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

WaveSketchBuilderParentPartType Enumeration

enum for scope of part

Property Detail

Associative

WaveSketchBuilder.Associative

Returns or sets the associative

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

Getter Method

Signature Associative

Returns: Return type:bool

New in version NX5.0.1.

License requirements: None.

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

Setter Method

Signature Associative

Parameters:associative (bool) –

New in version NX5.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

DisplayReferenceGeometry

WaveSketchBuilder.DisplayReferenceGeometry

Returns or sets the setting that controls whether or not the reference geometry in the linked sketch are displayed

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

Getter Method

Signature DisplayReferenceGeometry

Returns: Return type:bool

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature DisplayReferenceGeometry

Parameters:displayReferenceGeometry (bool) –

New in version NX11.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

HideOriginal

WaveSketchBuilder.HideOriginal

Returns or sets the hide original option

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

Getter Method

Signature HideOriginal

Returns: Return type:bool

New in version NX5.0.1.

License requirements: None.

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

Setter Method

Signature HideOriginal

Parameters:hideoriginal (bool) –

New in version NX5.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

InheritDisplayProperties

WaveSketchBuilder.InheritDisplayProperties

Returns or sets the inherit display property option

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

Getter Method

Signature InheritDisplayProperties

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature InheritDisplayProperties

Parameters:inheritDisplayProperties (bool) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

MakePositionIndependent

WaveSketchBuilder.MakePositionIndependent

Returns or sets the make position independent option

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

Getter Method

Signature MakePositionIndependent

Returns: Return type:bool

New in version NX5.0.1.

License requirements: None.

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

Setter Method

Signature MakePositionIndependent

Parameters:makePositionIndependent (bool) –

New in version NX5.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

ParentPart

WaveSketchBuilder.ParentPart

Returns or sets the source part type

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

Getter Method

Signature ParentPart

Returns: Return type:NXOpen.Features.WaveSketchBuilderParentPartType

New in version NX11.0.1.

License requirements: None.

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

Setter Method

Signature ParentPart

Parameters:parentPart (NXOpen.Features.WaveSketchBuilderParentPartType) –

New in version NX11.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

Sketches

WaveSketchBuilder.Sketches

Returns the sketch to link

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

Getter Method

Signature Sketches

Returns: Return type:NXOpen.SelectTaggedObjectList

New in version NX5.0.1.

License requirements: None.

SourcePartOccurrence

WaveSketchBuilder.SourcePartOccurrence

Returns or sets the source part occurrence

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

Getter Method

Signature SourcePartOccurrence

Returns: Return type:NXOpen.TaggedObject

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature SourcePartOccurrence

Parameters:sourcePartOcc (NXOpen.TaggedObject) –

New in version NX9.0.0.

License requirements: None.

Method Detail

CommitCreateOnTheFly

WaveSketchBuilder.CommitCreateOnTheFly

Commits the feature and set create on the fly flag

Signature CommitCreateOnTheFly()

Returns: Return type:NXOpen.Features.Feature

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

GetProductInterfaceObjects

WaveSketchBuilder.GetProductInterfaceObjects

Gets selected product interface objects

Signature GetProductInterfaceObjects()

Returns:items in list Return type:list of NXOpen.Assemblies.ProductInterface.InterfaceObject

New in version NX9.0.0.

License requirements: None.

GetSourcePartOccurrences

WaveSketchBuilder.GetSourcePartOccurrences

Gets source part occurrences

Signature GetSourcePartOccurrences()

Returns: Return type:list of NXOpen.TaggedObject

New in version NX10.0.0.

License requirements: None.

GetWaveLinkInformation

WaveSketchBuilder.GetWaveLinkInformation

Prints wave browser type information about link

Signature GetWaveLinkInformation()

Returns:a tuple Return type:A tuple consisting of (info, xformExists, xformOrigin, xformOrientation, xformScale). info is a str. queried wave information xformExists is a bool. true if there is a transform xformOrigin is a NXOpen.Point3d. transformation origin xformOrientation is a NXOpen.Matrix3x3. transformation matrix xformScale is a float. transformation scale

New in version NX6.0.0.

License requirements: wave (“WAVE FUNCTIONALITY”)

SetProductInterfaceObjects

WaveSketchBuilder.SetProductInterfaceObjects

Sets selected product interface objects

Signature SetProductInterfaceObjects(selectedObjects)

Parameters:selectedObjects (list of NXOpen.Assemblies.ProductInterface.InterfaceObject) – items in list

New in version NX9.0.0.

License requirements: None.

SetSourcePartOccurrences

WaveSketchBuilder.SetSourcePartOccurrences

Sets source part occurrences

Signature SetSourcePartOccurrences(sourcePartOccurrences)

Parameters:sourcePartOccurrences (list of NXOpen.TaggedObject) –

New in version NX10.0.0.

License requirements: None.

Validate

WaveSketchBuilder.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.