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

This class defines the top level object for use in definining the orientation of stiffeners and edge reinforcements. More...

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

Public Types

enum  MeasureAngleTypes { MeasureAngleTypesNormaltoCurve, MeasureAngleTypesOrthogonal }
 Settings to indicate how angles are measured in all orientation objects. More...
 
enum  PlacementSideTypes { PlacementSideTypesSameAsNormal, PlacementSideTypesOppositeNormal }
 Settings to indicate which side of the placement faces the stiffener is to be placed. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance used in the orientation objects to determine if vectors are parallel. More...
 
NXOpen::Features::ShipDesign::OrientationRegionItemBuilderCreateNewRegion (NXOpen::NXObject *regionPoint)
 Creates a new region on the landing curve to allow you to change the orientation for this area of the landing curve. More...
 
void CreatePathCurve (const std::vector< NXOpen::NXObject * > &curves)
 Sets the landing curve that is being processed into the builder. More...
 
void CreateRegionsAtFrames (std::vector< NXOpen::Features::ShipDesign::OrientationRegionItemBuilder * > &regions)
 Will create new regions at each frame. More...
 
void DeleteRegion (NXOpen::Features::ShipDesign::OrientationRegionItemBuilder *region)
 Deletes a previously created region. More...
 
double DistanceTolerance ()
 Returns the distance tolerance used in the orientation objects to determine if locations are coincident. More...
 
NXOpen::Features::ShipDesign::OrientationRegionItemBuilderGetNextRegion (NXOpen::Features::ShipDesign::OrientationRegionItemBuilder *region)
 Gets the next region to the current one. More...
 
NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::MeasureAngleTypes MeasureAngles ()
 Returns the method in which to measure angles in the orientation objects. More...
 
NXOpen::SelectNXObjectNewRegionPoint ()
 Returns the new region point or datum that will be used for the boundary of the new region. More...
 
NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::PlacementSideTypes PlacementSide ()
 Returns the side of the placement faces the stiffener is to be placed upon. More...
 
NXOpen::Features::ShipDesign::OrientationRegionItemBuilderRegionItemData ()
 Returns the regionItem builder. More...
 
NXOpen::Features::ShipDesign::OrientationRegionItemBuilderListRegionList ()
 Returns the list containing all the defined regions. More...
 
void SetAnglesNormal (const std::vector< NXOpen::Features::ShipDesign::OrientationRegionItemBuilder * > &regions)
 Will set all angle values of input regions so that web is normal to surface. More...
 
void SetAngleTolerance (double tolerance)
 Sets the angle tolerance used in the orientation objects to determine if vectors are parallel. More...
 
void SetDistanceTolerance (double tolerance)
 Sets the distance tolerance used in the orientation objects to determine if locations are coincident. More...
 
void SetMeasureAngles (NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::MeasureAngleTypes measureAngles)
 Sets the method in which to measure angles in the orientation objects. More...
 
void SetPlacementFaces (const std::vector< NXOpen::DisplayableObject * > &faces)
 Sets the faces or datum that are being processed into the builder. More...
 
void SetPlacementSide (NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::PlacementSideTypes placementSide)
 Sets the side of the placement faces the stiffener is to be placed upon. More...
 
void SetShowSurfaceAngles (bool showSurfaceAngles)
 Sets the indication if the surface angles analysis display is on or off. More...
 
void SetShowTwistRate (bool showTwistRate)
 Sets the indication if the twist rate analysis display is on or off. More...
 
void SetShowWebAngles (bool showWebAngles)
 Sets the indication if the web angle analysis display is on or off. More...
 
bool ShowSurfaceAngles ()
 Returns the indication if the surface angles analysis display is on or off. More...
 
bool ShowTwistRate ()
 Returns the indication if the twist rate analysis display is on or off. More...
 
bool ShowWebAngles ()
 Returns the indication if the web angle analysis display is on or off. 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 the top level object for use in definining the orientation of stiffeners and edge reinforcements.

This object allows you to define regions of a profile and allows you to define a different method of orientation for each region.
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateOrientationDefinitionBuilder
Default values.

Property Value

MeasureAngles

NormaltoCurve

ShowSurfaceAngles

0

ShowTwistRate

0

ShowWebAngles

0


Created in NX9.0.0.

Member Enumeration Documentation

Settings to indicate how angles are measured in all orientation objects.

Enumerator
MeasureAngleTypesNormaltoCurve 

Angles are measured in a plane normal to the landing curve.

MeasureAngleTypesOrthogonal 

Angles are measured in an orthogonal plane closest to the normal of the landing curve.

Settings to indicate which side of the placement faces the stiffener is to be placed.

Enumerator
PlacementSideTypesSameAsNormal 

The stiffener will be placed on the positive normal side of the placement faces.

PlacementSideTypesOppositeNormal 

The stiffener will be placed on the negative normal side of the placement faces.

Member Function Documentation

double NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::AngleTolerance ( )

Returns the angle tolerance used in the orientation objects to determine if vectors are parallel.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationRegionItemBuilder* NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::CreateNewRegion ( NXOpen::NXObject regionPoint)

Creates a new region on the landing curve to allow you to change the orientation for this area of the landing curve.

Returns

Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
Parameters
regionPointNew region boundary point
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::CreatePathCurve ( const std::vector< NXOpen::NXObject * > &  curves)

Sets the landing curve that is being processed into the builder.

If regions have already been defined the closest point on this new curve to the region boundaries will be used for the new region boundaries when the boundary has been defined by a specified point otherwise the boundary definition will be reevaluated for this new curve and the boundary set appropriately.
Created in NX9.0.0.

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

Parameters
curvesThe curves defining the path of the profile that is being oriented.
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::CreateRegionsAtFrames ( std::vector< NXOpen::Features::ShipDesign::OrientationRegionItemBuilder * > &  regions)

Will create new regions at each frame.


Created in NX9.0.0.

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

Parameters
regionsThe regions created.
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::DeleteRegion ( NXOpen::Features::ShipDesign::OrientationRegionItemBuilder region)

Deletes a previously created region.

The deleted region will be combined with the previous region.
Created in NX9.0.0.

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

Parameters
regionregion
double NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::DistanceTolerance ( )

Returns the distance tolerance used in the orientation objects to determine if locations are coincident.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationRegionItemBuilder* NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::GetNextRegion ( NXOpen::Features::ShipDesign::OrientationRegionItemBuilder region)

Gets the next region to the current one.

Returns

Created in NX9.0.0.

License requirements : nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")
Parameters
regionregion
NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::MeasureAngleTypes NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::MeasureAngles ( )

Returns the method in which to measure angles in the orientation objects.


Created in NX9.0.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::NewRegionPoint ( )

Returns the new region point or datum that will be used for the boundary of the new region.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::PlacementSideTypes NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::PlacementSide ( )

Returns the side of the placement faces the stiffener is to be placed upon.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationRegionItemBuilder* NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::RegionItemData ( )

Returns the regionItem builder.


Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationRegionItemBuilderList* NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::RegionList ( )

Returns the list containing all the defined regions.


Created in NX9.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetAnglesNormal ( const std::vector< NXOpen::Features::ShipDesign::OrientationRegionItemBuilder * > &  regions)

Will set all angle values of input regions so that web is normal to surface.


Created in NX9.0.0.

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

Parameters
regionsThe regions to process.
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetAngleTolerance ( double  tolerance)

Sets the angle tolerance used in the orientation objects to determine if vectors are parallel.


Created in NX9.0.0.

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

Parameters
tolerancetolerance
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetDistanceTolerance ( double  tolerance)

Sets the distance tolerance used in the orientation objects to determine if locations are coincident.


Created in NX9.0.0.

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

Parameters
tolerancetolerance
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetMeasureAngles ( NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::MeasureAngleTypes  measureAngles)

Sets the method in which to measure angles in the orientation objects.


Created in NX9.0.0.

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

Parameters
measureAnglesmeasureangles
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetPlacementFaces ( const std::vector< NXOpen::DisplayableObject * > &  faces)

Sets the faces or datum that are being processed into the builder.


Created in NX9.0.0.

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

Parameters
facesThe faces/datums defining the placement of the profile that is being oriented.
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetPlacementSide ( NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::PlacementSideTypes  placementSide)

Sets the side of the placement faces the stiffener is to be placed upon.


Created in NX9.0.0.

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

Parameters
placementSideplacementside
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetShowSurfaceAngles ( bool  showSurfaceAngles)

Sets the indication if the surface angles analysis display is on or off.


Created in NX9.0.0.

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

Parameters
showSurfaceAnglesshowsurfaceangles
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetShowTwistRate ( bool  showTwistRate)

Sets the indication if the twist rate analysis display is on or off.


Created in NX9.0.0.

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

Parameters
showTwistRateshowtwistrate
void NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::SetShowWebAngles ( bool  showWebAngles)

Sets the indication if the web angle analysis display is on or off.


Created in NX9.0.0.

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

Parameters
showWebAnglesshowwebangles
bool NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::ShowSurfaceAngles ( )

Returns the indication if the surface angles analysis display is on or off.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::ShowTwistRate ( )

Returns the indication if the twist rate analysis display is on or off.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::ShipDesign::OrientationDefinitionBuilder::ShowWebAngles ( )

Returns the indication if the web angle analysis display is on or off.


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.