NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::ShipDesign::OrientationRegionItemBuilder Class Reference

This class defines each region of the orientation. More...

Inheritance diagram for NXOpen::Features::ShipDesign::OrientationRegionItemBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OrientationMethodTypes {
  OrientationMethodTypesNormalToSurface, OrientationMethodTypesOrthogonal, OrientationMethodTypesLinearTwist, OrientationMethodTypesCubicTwist,
  OrientationMethodTypesAlongVector, OrientationMethodTypesPlanarAtAngle
}
 Settings to indicate how the web orientation is defined for this region. More...
 

Public Member Functions

NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilderAngleMethods ()
 Returns the angle definition for the region's orientation. More...
 
NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilderEndAngleMethods ()
 Returns the angle definition for the end of this region's orientation. More...
 
NXOpen::Features::ShipDesign::OrientationPointMethodsBuilderEndPointMethods ()
 Returns the boundary definition at the end of this region. More...
 
NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypes OrientationMethod ()
 Returns the orientation method used to define the direction of the web for this region. More...
 
void SetOrientationMethod (NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypes orientationMethod)
 Sets the orientation method used to define the direction of the web for this region. More...
 
NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilderStartAngleMethods ()
 Returns the angle definition for the start of this region's orientation. More...
 
NXOpen::Features::ShipDesign::OrientationPointMethodsBuilderStartPointMethods ()
 Returns the boundary definition at the start of this region. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This class defines each region of the orientation.


To create a new instance of this class, use NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::CreateNewRegion

Created in NX9.0.0.

Member Enumeration Documentation

Settings to indicate how the web orientation is defined for this region.

Enumerator
OrientationMethodTypesNormalToSurface 

The web of the profile is aligned normal to the placement surface.

Optionally an angle from this normal can be specified.

OrientationMethodTypesOrthogonal 

The web of the profile is aligned along the closest orthogonal direction to the placement surface normal.

Optionally an angle from this direction can be specified.

OrientationMethodTypesLinearTwist 

The web of the profile moves from a starting orientation to an ending orientation in a linear fashion.

OrientationMethodTypesCubicTwist 

The web of the profile moves from a starting orientation to an ending orientation in a cubic fashion.

OrientationMethodTypesAlongVector 

The web of the profile is aligned along the specified vector.

Optionally an angle from this direction can be specified.

OrientationMethodTypesPlanarAtAngle 

The web of the profile is planar with respect to the defined direction.

Optionally an angle from this direction can be specified.

Member Function Documentation

NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder* NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::AngleMethods ( )
NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder* NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::EndAngleMethods ( )

Returns the angle definition for the end of this region's orientation.

Only used when OrientationMethod is Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypesLinearTwist , of Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypesCubicTwist .
Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder* NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::EndPointMethods ( )

Returns the boundary definition at the end of this region.

Note this is NULL for the last region. The object output is the same as the start of the following region.
Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypes NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethod ( )

Returns the orientation method used to define the direction of the web for this region.


Created in NX9.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::SetOrientationMethod ( NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypes  orientationMethod)

Sets the orientation method used to define the direction of the web for this region.


Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
orientationMethodorientationmethod
NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder* NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::StartAngleMethods ( )

Returns the angle definition for the start of this region's orientation.

Only used when OrientationMethod is Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypesLinearTwist , of Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypesCubicTwist .
Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationPointMethodsBuilder* NXOpen::Features::ShipDesign::OrientationRegionItemBuilder::StartPointMethods ( )

Returns the boundary definition at the start of this region.

Note this is NULL for the first region. The object output is the same as the end of the previous region.
Created in NX9.0.0.

License requirements : None


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