LatticeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LatticeBuilder Class

class `NXOpen.Features.``LatticeBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Features.

  Lattice builder To create a new instance of this class, use `NXOpen.Features.LatticeFeatureCollection.CreateLatticeBuilder()`

  Default values.

  Property | Value
  --- | ---
  CellTypeName | Octapeak
  EdgeLength.Value | 10 (millimeters part), 0.5 (inches part)
  IsRandom | 0
  IsUniformCube | 1
  LatticeType | UnitGraph
  Layers | 1
  MaxDeviation.Value | 0.5 (millimeters part), 0.02 (inches part)
  MaxEdgeLength.Value | 10 (millimeters part), 0.5 (inches part)
  Offset.Value | 0 (millimeters part), 0 (inches part)
  RemoveDanglingRods | 0
  RemoveDisconnectedRods | 1
  ReverseFaceDirection | 0
  RodDiameter.Value | 1 (millimeters part), 0.05 (inches part)
  SizeX.Value | 10 (millimeters part), 0.5 (inches part)
  SizeY.Value | 10 (millimeters part), 0.5 (inches part)
  SizeZ.Value | 10 (millimeters part), 0.5 (inches part)
  TessellationFactor | 0.4

  New in version NX11.0.2.

# Properties

Property | Description
--- | ---
BaseFace | Returns the faces that the user selects to define the boundary
BoundaryBody | Returns the solid bodies that the user selects to define the boundary
CellTypeName | Returns or sets the name of the unit cell type that the user selects.
EdgeLength | Returns the edge length of the unit cell bounding box, and effective only when the bounding box is a uniform cube
FilterToolFace | Returns the faces of the boundary body that the dangling rods connected to will be removed from the lattice body
IsRandom | Returns or sets whether to randomize graph vertices within a specified range and generate some bumps for the lattice body.
IsUniformCube | Returns or sets whether the unit cell bounding box is a uniform cube
LatticeType | Returns or sets the type of lattice that is going to be created.
Layers | Returns or sets the number of unit cell layers stacked over each other.
MaxDeviation | Returns the maximum deviation that the vertices of the lattice graph will have.
Offset | Returns the offset of the conformal lattice from the base face.
Orientation | Returns or sets the orientation matrix of unit cell patterning in the lattice creation.
Origin | Returns or sets the origin where the unit cell patterning starts in the lattice creation
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
RemoveDanglingRods | Returns or sets whether to remove dangling rods from the lattice body. The dangling rods are defined as the following: <preserve> * Connects at only one end to the lattice body <preserve> * Touches or intersects a selected face of the boundary body The selected faces are (`Features.LatticeBuilder.FilterToolFace()`)
RemoveDisconnectedRods | Returns or sets whether to remove small disconnected lattice portions keeping just the largest body.
ReverseFaceDirection | Returns or sets whether the conformal lattice will be generated on the other side of the face
RodDiameter | Returns the diameter/thickness of the rods in the lattice graph
SizeX | Returns the size of the unit cell bounding box in x axis, and effective only when the bounding box is not a uniform cube
SizeY | Returns the size of the unit cell bounding box in y axis, and effective only when the bounding box is not a uniform cube
SizeZ | Returns the size of the unit cell bounding box in z axis, and effective only when the bounding box is not a uniform cube
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TessellationFactor | Returns or sets the tessellation factor of the lattice creation.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
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
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

LatticeBuilderLatticeTypes Enumeration | This enum represents the lattice types that are supported in NX.

# Property Detail

## BaseFace

`LatticeBuilder.``BaseFace`

  Returns the faces that the user selects to define the boundary

  `-------------------------------------`

  Getter Method

  Signature `BaseFace`

  Returns: |
  Return type: | `NXOpen.SelectFaceList`

  New in version NX11.0.2.

  License requirements: None.

## BoundaryBody

`LatticeBuilder.``BoundaryBody`

  Returns the solid bodies that the user selects to define the boundary

  `-------------------------------------`

  Getter Method

  Signature `BoundaryBody`

  Returns: |
  Return type: | `NXOpen.SelectBodyList`

  New in version NX11.0.2.

  License requirements: None.

## CellTypeName

`LatticeBuilder.``CellTypeName`

  Returns or sets the name of the unit cell type that the user selects.

  Currently there are 15 valid unit cells that are supported in NX. Their name strings are:

  > - BiTriangle
  > - Cubeplex
  > - Dodecahedron
  > - HexStar
  > - HexVase
  > - HexVaseMod
  > - Octapeak
  > - Octahedroid
  > - PseudoSierpinski
  > - QuadDiametral
  > - QuadDiametralCross
  > - QuadDiametralLine
  > - Star
  > - TriDiametral
  > - TriDiametralChevron

  `-------------------------------------`

  Getter Method

  Signature `CellTypeName`

  Returns: | Name of the unit cell to use
  Return type: | str

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CellTypeName`

  Parameters: | cellTypeName (str) –

  New in version NX11.0.2.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## EdgeLength

`LatticeBuilder.``EdgeLength`

  Returns the edge length of the unit cell bounding box, and effective only when the bounding box is a uniform cube

  `-------------------------------------`

  Getter Method

  Signature `EdgeLength`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.2.

  License requirements: None.

## FilterToolFace

`LatticeBuilder.``FilterToolFace`

  Returns the faces of the boundary body that the dangling rods connected to will be removed from the lattice body

  `-------------------------------------`

  Getter Method

  Signature `FilterToolFace`

  Returns: |
  Return type: | `NXOpen.SelectFaceList`

  New in version NX12.0.0.

  License requirements: None.

## IsRandom

`LatticeBuilder.``IsRandom`

  Returns or sets whether to randomize graph vertices within a specified range and generate some bumps for the lattice body.

  The range over which the vertices are randomized is determined by property `Features.LatticeBuilder.MaxDeviation()`.

  `-------------------------------------`

  Getter Method

  Signature `IsRandom`

  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IsRandom`

  Parameters: | random (bool) –

  New in version NX11.0.2.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## IsUniformCube

`LatticeBuilder.``IsUniformCube`

  Returns or sets whether the unit cell bounding box is a uniform cube

  `-------------------------------------`

  Getter Method

  Signature `IsUniformCube`

  Returns: |
  Return type: | bool

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IsUniformCube`

  Parameters: | uniformCube (bool) –

  New in version NX11.0.2.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## LatticeType

`LatticeBuilder.``LatticeType`

  Returns or sets the type of lattice that is going to be created.

  For now, the only supported lattice types are: `NXOpen.Features.LatticeBuilderLatticeTypes.UnitGraph` and `NXOpen.Features.LatticeBuilderLatticeTypes.ConformalGraph`.

  `-------------------------------------`

  Getter Method

  Signature `LatticeType`

  Returns: |
  Return type: | `NXOpen.Features.LatticeBuilderLatticeTypes`

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LatticeType`

  Parameters: | latticeType (`NXOpen.Features.LatticeBuilderLatticeTypes`) –

  New in version NX11.0.2.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## Layers

`LatticeBuilder.``Layers`

  Returns or sets the number of unit cell layers stacked over each other.

  The default is one layer only.

  `-------------------------------------`

  Getter Method

  Signature `Layers`

  Returns: |
  Return type: | int

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Layers`

  Parameters: | layers (int) –

  New in version NX12.0.0.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## MaxDeviation

`LatticeBuilder.``MaxDeviation`

  Returns the maximum deviation that the vertices of the lattice graph will have.

  The bigger the value of this property is, the more obvious bumps the lattice body will generate.

  `-------------------------------------`

  Getter Method

  Signature `MaxDeviation`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.2.

  License requirements: None.

## Offset

`LatticeBuilder.``Offset`

  Returns the offset of the conformal lattice from the base face.

  A negative offset will let the conformal lattice intersect with the base face (“into material”). A positive offset will move the conformal lattice away from the base face( “away from material”). Using a negative offset can ensure that the final lattice body will intersect with the base face, if that is required. The default offset is zero.

  `-------------------------------------`

  Getter Method

  Signature `Offset`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX12.0.0.

  License requirements: None.

## Orientation

`LatticeBuilder.``Orientation`

  Returns or sets the orientation matrix of unit cell patterning in the lattice creation.

  The orientation matrix is defined relative to the WCS.

  `-------------------------------------`

  Getter Method

  Signature `Orientation`

  Returns: |
  Return type: | `NXOpen.Matrix3x3`

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Orientation`

  Parameters: | orientMtx (`NXOpen.Matrix3x3`) –

  New in version NX11.0.2.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## Origin

`LatticeBuilder.``Origin`

  Returns or sets the origin where the unit cell patterning starts in the lattice creation

  `-------------------------------------`

  Getter Method

  Signature `Origin`

  Returns: |
  Return type: | `NXOpen.Point3d`

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Origin`

  Parameters: | origin (`NXOpen.Point3d`) –

  New in version NX11.0.2.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## RemoveDanglingRods

`LatticeBuilder.``RemoveDanglingRods`

  Returns or sets whether to remove dangling rods from the lattice body.

  The dangling rods are defined as the following:

  > - Connects at only one end to the lattice body
  > - Touches or intersects a selected face of the boundary body

  The selected faces are (`Features.LatticeBuilder.FilterToolFace()`)

  `-------------------------------------`

  Getter Method

  Signature `RemoveDanglingRods`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RemoveDanglingRods`

  Parameters: | remove (bool) –

  New in version NX12.0.0.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## RemoveDisconnectedRods

`LatticeBuilder.``RemoveDisconnectedRods`

  Returns or sets whether to remove small disconnected lattice portions keeping just the largest body.

  `-------------------------------------`

  Getter Method

  Signature `RemoveDisconnectedRods`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RemoveDisconnectedRods`

  Parameters: | remove (bool) –

  New in version NX12.0.0.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## ReverseFaceDirection

`LatticeBuilder.``ReverseFaceDirection`

  Returns or sets whether the conformal lattice will be generated on the other side of the face

  `-------------------------------------`

  Getter Method

  Signature `ReverseFaceDirection`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ReverseFaceDirection`

  Parameters: | reverseFaceDir (bool) –

  New in version NX12.0.0.

  License requirements: nx_lattice_base (” NX Lattice Base”)

## RodDiameter

`LatticeBuilder.``RodDiameter`

  Returns the diameter/thickness of the rods in the lattice graph

  `-------------------------------------`

  Getter Method

  Signature `RodDiameter`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.2.

  License requirements: None.

## SizeX

`LatticeBuilder.``SizeX`

  Returns the size of the unit cell bounding box in x axis, and effective only when the bounding box is not a uniform cube

  `-------------------------------------`

  Getter Method

  Signature `SizeX`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.2.

  License requirements: None.

## SizeY

`LatticeBuilder.``SizeY`

  Returns the size of the unit cell bounding box in y axis, and effective only when the bounding box is not a uniform cube

  `-------------------------------------`

  Getter Method

  Signature `SizeY`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.2.

  License requirements: None.

## SizeZ

`LatticeBuilder.``SizeZ`

  Returns the size of the unit cell bounding box in z axis, and effective only when the bounding box is not a uniform cube

  `-------------------------------------`

  Getter Method

  Signature `SizeZ`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.2.

  License requirements: None.

## TessellationFactor

`LatticeBuilder.``TessellationFactor`

  Returns or sets the tessellation factor of the lattice creation.

  A tessellation tolerance specifies the maximum deviation between the ideal rod and their final tessellated representation of the lattice body. Since the result heavily depends on the relation between rod diameter and tessellation tolerance the user specifies only a unitless tessellation factor. The actual tessellation tolerance will determined by (`Features.LatticeBuilder.TessellationFactor`()`) X (`Features.LatticeBuilder.RodDiameter()`)

  `-------------------------------------`

  Getter Method

  Signature `TessellationFactor`

  Returns: |
  Return type: | float

  New in version NX11.0.2.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TessellationFactor`

  Parameters: | factor (float) –

  New in version NX11.0.2.

  License requirements: nx_lattice_base (” NX Lattice Base”)

# Method Detail

## Validate

`LatticeBuilder.``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.