SubdivisionProjectCageBuilder Class¶
-
class
NXOpen.Features.Subdivision.
SubdivisionProjectCageBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Features.Subdivision.SubdivisionProjectCageBuilder
builderTo create a new instance of this class, use
NXOpen.Features.Subdivision.SubdivisionBodyCollection.CreateSubdivisionProjectCageBuilder
Default values.
Property Value Mode Planar TargetType InferredPlane New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
Mode | Returns or sets the mode |
ObjectsToProject | Returns the objects to project |
Tag | Returns the Tag for this object. |
Target | Returns the target |
TargetCageObjects | Returns the target cage objects to infer a plane or axis from |
TargetDynamicPlane | Returns or sets the target dynamic plane |
TargetPlane | Returns or sets the target plane |
TargetType | Returns or sets the target type |
Type | Returns or sets the type |
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. |
OnTargetDynamicPlane | Update builder data based on target dynamic plane definition |
OnTargetPlane | Update builder data based on target plane definition |
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¶
SubdivisionProjectCageBuilderModeOptions Enumeration | Best fit mode |
SubdivisionProjectCageBuilderTargetTypes Enumeration | Target types |
SubdivisionProjectCageBuilderTypes Enumeration | The type of projection |
Property Detail¶
Mode¶
-
SubdivisionProjectCageBuilder.
Mode
¶ Returns or sets the mode
-------------------------------------
Getter Method
Signature
Mode()
Returns: Return type: NXOpen.Features.Subdivision.SubdivisionProjectCageBuilderModeOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Mode(mode)
Parameters: mode ( NXOpen.Features.Subdivision.SubdivisionProjectCageBuilderModeOptions
) –New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
ObjectsToProject¶
-
SubdivisionProjectCageBuilder.
ObjectsToProject
¶ Returns the objects to project
-------------------------------------
Getter Method
Signature
ObjectsToProject()
Returns: Return type: NXOpen.Features.Subdivision.SelectCageObjectData
New in version NX9.0.0.
License requirements: None.
Target¶
-
SubdivisionProjectCageBuilder.
Target
¶ Returns the target
-------------------------------------
Getter Method
Signature
Target()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX9.0.0.
License requirements: None.
TargetCageObjects¶
-
SubdivisionProjectCageBuilder.
TargetCageObjects
¶ Returns the target cage objects to infer a plane or axis from
-------------------------------------
Getter Method
Signature
TargetCageObjects()
Returns: Return type: NXOpen.Features.Subdivision.SelectCageObjectData
New in version NX9.0.0.
License requirements: None.
TargetDynamicPlane¶
-
SubdivisionProjectCageBuilder.
TargetDynamicPlane
¶ Returns or sets the target dynamic plane
-------------------------------------
Getter Method
Signature
TargetDynamicPlane()
Returns: Return type: NXOpen.CoordinateSystem
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetDynamicPlane(csys)
Parameters: csys ( NXOpen.CoordinateSystem
) –New in version NX10.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
TargetPlane¶
-
SubdivisionProjectCageBuilder.
TargetPlane
¶ Returns or sets the target plane
-------------------------------------
Getter Method
Signature
TargetPlane()
Returns: Return type: NXOpen.Plane
New in version NX9.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetPlane(plane)
Parameters: plane ( NXOpen.Plane
) –New in version NX9.0.1.
License requirements: nx_subdivision (” NX SUBDIVISION”)
TargetType¶
-
SubdivisionProjectCageBuilder.
TargetType
¶ Returns or sets the target type
-------------------------------------
Getter Method
Signature
TargetType()
Returns: Return type: NXOpen.Features.Subdivision.SubdivisionProjectCageBuilderTargetTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetType(targetType)
Parameters: targetType ( NXOpen.Features.Subdivision.SubdivisionProjectCageBuilderTargetTypes
) –New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Type¶
-
SubdivisionProjectCageBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Features.Subdivision.SubdivisionProjectCageBuilderTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Features.Subdivision.SubdivisionProjectCageBuilderTypes
) –New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Method Detail¶
OnTargetDynamicPlane¶
-
SubdivisionProjectCageBuilder.
OnTargetDynamicPlane
¶ Update builder data based on target dynamic plane definition
Signature
OnTargetDynamicPlane()
New in version NX10.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
OnTargetPlane¶
-
SubdivisionProjectCageBuilder.
OnTargetPlane
¶ Update builder data based on target plane definition
Signature
OnTargetPlane()
New in version NX9.0.1.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Validate¶
-
SubdivisionProjectCageBuilder.
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.