This class defines the method of angle definition used in the definition of the region's orientation. More...

Inheritance diagram for NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder:

Public Types
enum	AlignAtTypes { AlignAtTypesStart, AlignAtTypesEnd }
	Is the angle to be aligned with the region adjacent to start of this region or adjacent to the end of this region. More...

enum	MethodTypes { MethodTypesAngle, MethodTypesVector, MethodTypesAligned }
	Settings used to determine how the angle is defined. More...

Public Member Functions
NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AlignAtTypes	AlignAt ()
	Returns the indication if the region should be aligned with the adjacent region at the start of this region, or with the adjacent region at the end of this region.

NXOpen::Direction *	AlignVector ()
	Returns the vector used to calculate the angle by aligning to this vector.

NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypes	AngleMethod ()
	Returns the method used to calculate the angle.

NXOpen::Plane *	AngleReference ()
	Returns the object used to measure the angle from.

NXOpen::Expression *	MountingAngle ()
	Returns the constant angle value to rotate from the given vector or reference object.

void	SetAlignAt (NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AlignAtTypes alignAt)
	Sets the indication if the region should be aligned with the adjacent region at the start of this region, or with the adjacent region at the end of this region.

void	SetAlignVector (NXOpen::Direction *alignVector)
	Sets the vector used to calculate the angle by aligning to this vector.

void	SetAngleMethod (NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypes angleMethod)
	Sets the method used to calculate the angle.

void	SetAngleReference (NXOpen::Plane *angleReference)
	Sets the object used to measure the angle from.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

This class defines the method of angle definition used in the definition of the region's orientation.

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AlignAtTypes

Is the angle to be aligned with the region adjacent to start of this region or adjacent to the end of this region.

Note the Start setting cannot be used for the first region, and the End setting cannot be used for the last region.

Enumerator:

AlignAtTypesStart	start
AlignAtTypesEnd	end

enum NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypes

Settings used to determine how the angle is defined.

Enumerator:

MethodTypesAngle	Angle is defined by specifying a constant angle from a reference object.
MethodTypesVector	Angle is defined by specifying a vector to align with.
MethodTypesAligned	Angle is the same as the previous or following region.

Member Function Documentation

NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AlignAtTypes NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AlignAt ( )

Returns the indication if the region should be aligned with the adjacent region at the start of this region, or with the adjacent region at the end of this region.

Only used when Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethod is Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypesPlanarAtAngle .
Created in NX9.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AlignVector ( )

Returns the vector used to calculate the angle by aligning to this vector.

Only used when AngleMethod is Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypesVector .
Created in NX9.0.0.

License requirements : None

NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypes NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AngleMethod ( )

Returns the method used to calculate the angle.

Created in NX9.0.0.

License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AngleReference ( )

Returns the object used to measure the angle from.

Only used when AngleMethod is Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypesAngle .
Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::MountingAngle ( )

Returns the constant angle value to rotate from the given vector or reference object.

Created in NX9.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::SetAlignAt ( NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::AlignAtTypes alignAt )

Sets the indication if the region should be aligned with the adjacent region at the start of this region, or with the adjacent region at the end of this region.

Only used when Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethod is Features::ShipDesign::OrientationRegionItemBuilder::OrientationMethodTypesPlanarAtAngle .
Created in NX9.0.0.

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

Parameters

alignAt alignat

void NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::SetAlignVector ( NXOpen::Direction * alignVector )

Sets the vector used to calculate the angle by aligning to this vector.

Only used when AngleMethod is Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypesVector .
Created in NX9.0.0.

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

Parameters

alignVector alignvector

void NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::SetAngleMethod ( NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypes angleMethod )

Sets the method used to calculate the angle.

Created in NX9.0.0.

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

Parameters

angleMethod anglemethod

void NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::SetAngleReference ( NXOpen::Plane * angleReference )

Sets the object used to measure the angle from.

Only used when AngleMethod is Features::ShipDesign::OrientationAngleMethodsBuilder::MethodTypesAngle .
Created in NX9.0.0.

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

Parameters

angleReference anglereference

virtual bool NXOpen::Features::ShipDesign::OrientationAngleMethodsBuilder::Validate ( )

virtual

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.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

The documentation for this class was generated from the following file:

Features_ShipDesign_OrientationAngleMethodsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation