NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::BlockFeatureBuilder Class Reference

Represents a block feature builder. More...

Inheritance diagram for NXOpen::Features::BlockFeatureBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  Types { TypesOriginAndEdgeLengths, TypesTwoPointsAndHeight, TypesDiagonalPoints }
 Represents the block types. More...

Public Member Functions

NXOpen::GeometricUtilities::BooleanOperationBooleanOption ()
 Returns the boolean option
Created in NX6.0.0.
NXOpen::Features::Feature::BooleanType BooleanType ()
 Returns the boolean operation for the block
Created in NX4.0.0.
void GetOrientation (NXOpen::Vector3d *xAxis, NXOpen::Vector3d *yAxis)
 Gets the orientation (x and y axes) of the block.
NXOpen::ExpressionHeight ()
 Returns the expression representing the block height.
NXOpen::ExpressionLength ()
 Returns the expression representing the block length.
NXOpen::Point3d Origin ()
 Returns the point coordinates representing the block origin.
NXOpen::PointOriginPoint ()
 Returns the block origin point
Created in NX6.0.0.
bool ParentAssociativity ()
 Returns the option to keep associativity of the Origin and Origin Offset Points
Created in NX8.0.0.
NXOpen::PointPointFromOrigin ()
 Returns the point which defines values along the x, y axes of the WCS from origin point, when type is two point and height.
void SetBooleanOperationAndTarget (NXOpen::Features::Feature::BooleanType booleanOperation, NXOpen::Body *targetBody)
 Set the boolean operation for creating the block and the boolean operation target body
Created in NX3.0.0.
void SetBooleanType (NXOpen::Features::Feature::BooleanType booleanType)
 Sets the boolean operation for the block
Created in NX4.0.0.
void SetHeight (const NXString &height)
 The expression representing the block height.
void SetLength (const NXString &length)
 The expression representing the block length.
void SetOrientation (const NXOpen::Vector3d &xAxis, const NXOpen::Vector3d &yAxis)
 Sets the orientation for the block
Created in NX4.0.0.
void SetOrigin (const NXOpen::Point3d &origin)
 Sets the point coordinates representing the block origin.
void SetOriginAndLengths (const NXOpen::Point3d &originPoint, const NXString &lengthExpression, const NXString &widthExpression, const NXString &heightExpression)
 Create a block by setting the origin and the block length, width, and height.
void SetOriginPoint (NXOpen::Point *blockOriginPoint)
 Sets the block origin point
Created in NX6.0.0.
void SetParentAssociativity (bool parentAssociativity)
 Sets the option to keep associativity of the Origin and Origin Offset Points
Created in NX8.0.0.
void SetPointFromOrigin (NXOpen::Point *blockPointFromOrigin)
 Sets the point which defines values along the x, y axes of the WCS from origin point, when type is two point and height.
void SetTarget (NXOpen::Body *target)
 Sets the target body for the boolean operation (if any) for the block
Created in NX4.0.0.
void SetTwoDiagonalPoints (const NXOpen::Point3d &originPoint, const NXOpen::Point3d &cornerPoint)
 Create a block by setting two diagonal points, one at the block origin and one at the opposite corner point.
void SetTwoPointsAndHeight (const NXOpen::Point3d &originPoint, const NXOpen::Point3d &cornerPoint, const NXString &heightExpression)
 Create a block by setting the block height and two diagonal points in the WCS x-y plane.
void SetType (NXOpen::Features::BlockFeatureBuilder::Types type)
 Sets the type represented by Features::BlockFeatureBuilder::Types
Created in NX6.0.0.
void SetWidth (const NXString &width)
 The expression representing the block width.
NXOpen::BodyTarget ()
 Returns the target body for the boolean operation (if any) for the block
Created in NX4.0.0.
NXOpen::Features::BlockFeatureBuilder::Types Type ()
 Returns the type represented by Features::BlockFeatureBuilder::Types
Created in NX6.0.0.
NXOpen::ExpressionWidth ()
 Returns the expression representing the block width.

Detailed Description

Represents a block feature builder.


To create a new instance of this class, use Features::FeatureCollection::CreateBlockFeatureBuilder

Created in NX3.0.0.


Member Enumeration Documentation

Represents the block types.

Enumerator:
TypesOriginAndEdgeLengths 

Represents the block created by providing Origin and Edge Lengths.

TypesTwoPointsAndHeight 

Represents the block created by providing Two Points and Height.

TypesDiagonalPoints 

Represents the block created by providing Diagonal Points.


Member Function Documentation

Returns the boolean option
Created in NX6.0.0.



License requirements : None

Returns the boolean operation for the block
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Gets the orientation (x and y axes) of the block.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
xAxisx axis
yAxisy axis

Returns the expression representing the block height.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Returns the expression representing the block length.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Returns the point coordinates representing the block origin.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Returns the block origin point
Created in NX6.0.0.



License requirements : None

Returns the option to keep associativity of the Origin and Origin Offset Points
Created in NX8.0.0.



License requirements : None

Returns the point which defines values along the x, y axes of the WCS from origin point, when type is two point and height.

the point which defines values along the x, y and z axes of the WCS from origin point, when type is diagonal points.


Created in NX6.0.0.

License requirements : None

Set the boolean operation for creating the block and the boolean operation target body
Created in NX3.0.0.



License requirements : features_modeling ("FEATURES MODELING"), solid_modeling ("SOLIDS MODELING")

Parameters:
booleanOperationType of boolean operation.
targetBodyTarget body for boolean operation. Set to a null reference (Nothing in Visual Basic) for a boolean create operation.

Sets the boolean operation for the block
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
booleanTypeboolean type

The expression representing the block height.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
height
NOTE: The full Unicode character set is not supported for this parameter.

The expression representing the block length.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
length
NOTE: The full Unicode character set is not supported for this parameter.

Sets the orientation for the block
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
xAxisx axis
yAxisy axis

Sets the point coordinates representing the block origin.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
originorigin
void NXOpen::Features::BlockFeatureBuilder::SetOriginAndLengths ( const NXOpen::Point3d originPoint,
const NXString lengthExpression,
const NXString widthExpression,
const NXString heightExpression 
)

Create a block by setting the origin and the block length, width, and height.

The origin of the block is specified by the input origin point in absolute coordinates. The orientation of the block is along the x, y, and z axes of the WCS.
Created in NX3.0.0.

License requirements : features_modeling ("FEATURES MODELING"), solid_modeling ("SOLIDS MODELING")

Parameters:
originPointBlock origin point
lengthExpressionBlock length in the WCS x direction
NOTE: The full Unicode character set is not supported for this parameter.
widthExpressionBlock width in the WCS y direction
NOTE: The full Unicode character set is not supported for this parameter.
heightExpressionBlock height in the WCS z direction
NOTE: The full Unicode character set is not supported for this parameter.

Sets the block origin point
Created in NX6.0.0.



License requirements : None

Parameters:
blockOriginPointblockoriginpoint

Sets the option to keep associativity of the Origin and Origin Offset Points
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING"), solid_modeling ("SOLIDS MODELING")

Parameters:
parentAssociativityparentassociativity

Sets the point which defines values along the x, y axes of the WCS from origin point, when type is two point and height.

the point which defines values along the x, y and z axes of the WCS from origin point, when type is diagonal points.


Created in NX6.0.0.

License requirements : None

Parameters:
blockPointFromOriginblockpointfromorigin

Sets the target body for the boolean operation (if any) for the block
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
targettarget
void NXOpen::Features::BlockFeatureBuilder::SetTwoDiagonalPoints ( const NXOpen::Point3d originPoint,
const NXOpen::Point3d cornerPoint 
)

Create a block by setting two diagonal points, one at the block origin and one at the opposite corner point.

The orientation of the block is along the x, y, and z axes of the WCS.
Created in NX3.0.0.

License requirements : features_modeling ("FEATURES MODELING"), solid_modeling ("SOLIDS MODELING")

Parameters:
originPointBlock origin point
cornerPointBlock corner point, diagonal from the block origin point
void NXOpen::Features::BlockFeatureBuilder::SetTwoPointsAndHeight ( const NXOpen::Point3d originPoint,
const NXOpen::Point3d cornerPoint,
const NXString heightExpression 
)

Create a block by setting the block height and two diagonal points in the WCS x-y plane.

The orientation of the block is along the x, y, and z axes of the WCS.
Created in NX3.0.0.

License requirements : features_modeling ("FEATURES MODELING"), solid_modeling ("SOLIDS MODELING")

Parameters:
originPointBlock origin point
cornerPointBlock 2d corner point, diagonal in WCS x-y plane from the block origin point.
heightExpressionBlock height in the WCS z direction
NOTE: The full Unicode character set is not supported for this parameter.

Sets the type represented by Features::BlockFeatureBuilder::Types
Created in NX6.0.0.



License requirements : None

Parameters:
typetype

The expression representing the block width.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
width
NOTE: The full Unicode character set is not supported for this parameter.

Returns the target body for the boolean operation (if any) for the block
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Returns the type represented by Features::BlockFeatureBuilder::Types
Created in NX6.0.0.



License requirements : None

Returns the expression representing the block width.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.