Represents a NXOpen::GeometricUtilities::ScalingMethodBuilder. More...

Inheritance diagram for NXOpen::GeometricUtilities::ScalingMethodBuilder:

Public Types
enum	BlendingFunctionTypes { BlendingFunctionTypesLinear, BlendingFunctionTypesCubic }
	This enum represents the blending function type, if the scaling by BlendingFunction is selected. More...

enum	ScalingOptions { ScalingOptionsConstant, ScalingOptionsByBlendingFunction, ScalingOptionsByAnotherCurve, ScalingOptionsByAPoint, ScalingOptionsByAreaLaw, ScalingOptionsByPerimeterLaw, ScalingOptionsUniform, ScalingOptionsLateral }
	This enum represents the scaling method option. More...

Public Member Functions
NXOpen::GeometricUtilities::LawBuilder *	AreaLaw ()
	Returns the area law. More...

NXOpen::GeometricUtilities::ScalingMethodBuilder::BlendingFunctionTypes	BlendingFunctionType ()
	Returns the blending function. More...

double	EndBlendScaleFactor ()
	Returns the end blend scale factor. More...

NXOpen::GeometricUtilities::LawBuilder *	PerimeterLaw ()
	Returns the perimeter law. More...

double	ScaleFactor ()
	Returns the scale factor. More...

NXOpen::Section *	ScalingCurve ()
	Returns the scaling curve. More...

NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingOptions	ScalingOption ()
	Returns the scaling method option. More...

NXOpen::Point *	ScalingPoint ()
	Returns the scaling point. More...

void	SetBlendingFunctionType (NXOpen::GeometricUtilities::ScalingMethodBuilder::BlendingFunctionTypes blendingFunctionType)
	Sets the blending function. More...

void	SetEndBlendScaleFactor (double endBlendScaleFactor)
	Sets the end blend scale factor. More...

void	SetScaleFactor (double scaleFactor)
	Sets the scale factor. More...

void	SetScalingOption (NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingOptions scalingOption)
	Sets the scaling method option. More...

void	SetScalingPoint (NXOpen::Point *scalingPoint)
	Sets the scaling point. More...

void	SetStartBlendScaleFactor (double startBlendScaleFactor)
	Sets the start blend scale factor. More...

double	StartBlendScaleFactor ()
	Returns the start blend scale factor. 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

Represents a NXOpen::GeometricUtilities::ScalingMethodBuilder.

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::ScalingMethodBuilder::BlendingFunctionTypes

This enum represents the blending function type, if the scaling by BlendingFunction is selected.

Enumerator
BlendingFunctionTypesLinear	Linear.
BlendingFunctionTypesCubic	Cubic.

enum NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingOptions

This enum represents the scaling method option.

By default, it is set to Constant. Uniform and Lateral scaling options are invalid if only 1 guide is selected.

Enumerator
ScalingOptionsConstant	Constant.
ScalingOptionsByBlendingFunction	Blending Function.
ScalingOptionsByAnotherCurve	Another Curve.
ScalingOptionsByAPoint	A Point.
ScalingOptionsByAreaLaw	Area Law.
ScalingOptionsByPerimeterLaw	Perimeter Law.
ScalingOptionsUniform	Uniform, available only if 2 guides are selected.
ScalingOptionsLateral	Lateral, available only if 2 guides are selected.

Member Function Documentation

NXOpen::GeometricUtilities::LawBuilder* NXOpen::GeometricUtilities::ScalingMethodBuilder::AreaLaw ( )

Returns the area law.

For scaling by Area Law, the input law governs the cross sectional area at the start and end of the guide curve.
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::ScalingMethodBuilder::BlendingFunctionTypes NXOpen::GeometricUtilities::ScalingMethodBuilder::BlendingFunctionType ( )

Returns the blending function.

Allows linear or cubic scaling between specified starting and ending scale factors, which correspond to the start and end of the guide string.
Created in NX5.0.0.

License requirements : None

double NXOpen::GeometricUtilities::ScalingMethodBuilder::EndBlendScaleFactor ( )

Returns the end blend scale factor.

For scaling by Blending Function, the end scale factor will be applied at the end point of the guide curve.
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::LawBuilder* NXOpen::GeometricUtilities::ScalingMethodBuilder::PerimeterLaw ( )

Returns the perimeter law.

For scaling by Perimeter Law, the input law governs the perimeter of the sections at the start and end of the guide curve.
Created in NX5.0.0.

License requirements : None

double NXOpen::GeometricUtilities::ScalingMethodBuilder::ScaleFactor ( )

Returns the scale factor.

For Constant scaling method, the scale factor will be applied to all sections along the guide.
Created in NX5.0.0.

License requirements : None

NXOpen::Section* NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingCurve ( )

Returns the scaling curve.

For scaling by Another Curve, the scale at any given point is based on the length of the ruling between the guide string and the input scaling curve.
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingOptions NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingOption ( )

Returns the scaling method option.

Except for Uniform and Lateral scaling methods, additional parameters and/or inputs are required.
Created in NX5.0.0.

License requirements : None

NXOpen::Point* NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingPoint ( )

Returns the scaling point.

For scaling by a Point, the scale at any given point is based on the length of the ruling between the guide string and the input point.
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricUtilities::ScalingMethodBuilder::SetBlendingFunctionType ( NXOpen::GeometricUtilities::ScalingMethodBuilder::BlendingFunctionTypes blendingFunctionType )

Sets the blending function.

Allows linear or cubic scaling between specified starting and ending scale factors, which correspond to the start and end of the guide string.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

blendingFunctionType blendingfunctiontype

void NXOpen::GeometricUtilities::ScalingMethodBuilder::SetEndBlendScaleFactor ( double endBlendScaleFactor )

Sets the end blend scale factor.

For scaling by Blending Function, the end scale factor will be applied at the end point of the guide curve.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

endBlendScaleFactor endblendscalefactor

void NXOpen::GeometricUtilities::ScalingMethodBuilder::SetScaleFactor ( double scaleFactor )

Sets the scale factor.

For Constant scaling method, the scale factor will be applied to all sections along the guide.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

scaleFactor scalefactor

void NXOpen::GeometricUtilities::ScalingMethodBuilder::SetScalingOption ( NXOpen::GeometricUtilities::ScalingMethodBuilder::ScalingOptions scalingOption )

Sets the scaling method option.

Except for Uniform and Lateral scaling methods, additional parameters and/or inputs are required.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

scalingOption scalingoption

void NXOpen::GeometricUtilities::ScalingMethodBuilder::SetScalingPoint ( NXOpen::Point * scalingPoint )

Sets the scaling point.

For scaling by a Point, the scale at any given point is based on the length of the ruling between the guide string and the input point.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

scalingPoint scalingpoint

void NXOpen::GeometricUtilities::ScalingMethodBuilder::SetStartBlendScaleFactor ( double startBlendScaleFactor )

Sets the start blend scale factor.

For scaling by Blending Function, the start scale factor will be applied at the starting of the guide curve.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

startBlendScaleFactor startblendscalefactor

double NXOpen::GeometricUtilities::ScalingMethodBuilder::StartBlendScaleFactor ( )

Returns the start blend scale factor.

For scaling by Blending Function, the start scale factor will be applied at the starting of the guide curve.
Created in NX5.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::ScalingMethodBuilder::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:

GeometricUtilities_ScalingMethodBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation