NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAM::InterpolateVector Class Reference

Represents builder of Interpolate Vector, one option of Tool Axis
Created in NX7.5.0. More...

Inheritance diagram for NXOpen::CAM::InterpolateVector:
NXOpen::CAM::ToolAxisInterpolate NXOpen::TaggedObject

Public Member Functions

bool ApplyLeadTilt ()
 Returns a boolean value that indicates whether the lead and tilt angles needs to be given more precedence
Created in NX11.0.1. More...
 
void Erase (int index)
 Delete an existing item by index
Created in NX7.5.0. More...
 
double GetLeadAngle (int index)
 Get the lead angle. More...
 
NXOpen::CAM::InheritableToolDepBuilderGetPreviewMaximumDistanceBuilder ()
 The preview maximum distance(inheritable tool dependent) More...
 
double GetTiltAngle (int index)
 Get the Tilt angle. More...
 
NXOpen::DirectionGetVector (int index)
 Get the vector. More...
 
void Insert (int inputIndex, NXOpen::Point *point, NXOpen::NXObject *view, NXOpen::Direction *vector)
 Add a new item
Created in NX7.5.0. More...
 
double MinimumLeadAngle ()
 Returns the minimum lead angle
Created in NX8.5.0. More...
 
void Modify (int index, NXOpen::Point *point, NXOpen::Direction *vector)
 Modify an existing item by index
Created in NX7.5.0. More...
 
void Modify (int index, NXOpen::Point *point, NXOpen::Direction *vector, bool ignorePoint)
 Modify an existing item by index
Created in NX11.0.1. More...
 
void MoveDown (int index)
 Move down an item
Created in NX7.5.0. More...
 
void MoveUp (int index)
 Move up an item
Created in NX7.5.0. More...
 
void SetApplyLeadTilt (bool applyLeadTilt)
 Sets a boolean value that indicates whether the lead and tilt angles needs to be given more precedence
Created in NX11.0.1. More...
 
void SetLeadAngle (int index, double leadAngle)
 Set the lead angle
Created in NX11.0.1. More...
 
void SetMinimumLeadAngle (double minLeadAngle)
 Sets the minimum lead angle
Created in NX8.5.0. More...
 
void SetSmoothingMethod (int smoothingOption)
 Sets the smoothing method
Created in NX11.0.1. More...
 
void SetTiltAngle (double tiltAngle)
 Sets the tilt angle
Created in NX7.5.2. More...
 
void SetTiltAngle (int index, double tiltAngle)
 Set the tilt angle
Created in NX11.0.1. More...
 
int SmoothingMethod ()
 Returns the smoothing method
Created in NX11.0.1. More...
 
double TiltAngle ()
 Returns the tilt angle
Created in NX7.5.2. More...
 
- Public Member Functions inherited from NXOpen::CAM::ToolAxisInterpolate
NXOpen::CAM::ToolAxisInterpolate::ControlDirectionTypes ControlDirection ()
 Returns the control direction type
Created in NX11.0.1. More...
 
NXOpen::PointGetPoint (int index)
 Get the point. More...
 
int GetTotalNumberOfPoints ()
 Get the total number of interpolate data points. More...
 
NXOpen::CAM::ToolAxisInterpolate::InterpolationMethodTypes InterpolationMethod ()
 Returns the interpolation method type
Created in NX7.5.0. More...
 
void ResetToDefault ()
 The action of Reset to Default
Created in NX7.5.0. More...
 
void SetControlDirection (NXOpen::CAM::ToolAxisInterpolate::ControlDirectionTypes newValue)
 Sets the control direction type
Created in NX11.0.1. More...
 
void SetInterpolationMethod (NXOpen::CAM::ToolAxisInterpolate::InterpolationMethodTypes newValue)
 Sets the interpolation method type
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen::CAM::ToolAxisInterpolate
enum  ControlDirectionTypes { ControlDirectionTypesUandv, ControlDirectionTypesU, ControlDirectionTypesV }
 the available types for the control direction More...
 
enum  InterpolateTypes { InterpolateTypesVector, InterpolateTypesAngleToPart, InterpolateTypesAngleToDrive }
 the available types for Interpolate Types More...
 
enum  InterpolationMethodTypes { InterpolationMethodTypesLinear, InterpolationMethodTypesCubicSpline, InterpolationMethodTypesSmooth }
 the available types for interpolate method More...
 
enum  TurnInputModeTypes { TurnInputModeTypesHolderAngleFromPart, TurnInputModeTypesClearanceAngle, TurnInputModeTypesCuttingAngle }
 the available types for turn input mode More...
 
enum  TurnInterpolationMethodTypes { TurnInterpolationMethodTypesAbsolute, TurnInterpolationMethodTypesRelative }
 the available types for turn interpolation method More...
 

Detailed Description

Represents builder of Interpolate Vector, one option of Tool Axis
Created in NX7.5.0.


Member Function Documentation

bool NXOpen::CAM::InterpolateVector::ApplyLeadTilt ( )

Returns a boolean value that indicates whether the lead and tilt angles needs to be given more precedence
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

void NXOpen::CAM::InterpolateVector::Erase ( int  index)

Delete an existing item by index
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
indexthe index of deleted item
double NXOpen::CAM::InterpolateVector::GetLeadAngle ( int  index)

Get the lead angle.

Returns
the lead angle
Created in NX11.0.1.

License requirements : cam_base ("CAM BASE")
Parameters
indexthe index of item
NXOpen::CAM::InheritableToolDepBuilder* NXOpen::CAM::InterpolateVector::GetPreviewMaximumDistanceBuilder ( )

The preview maximum distance(inheritable tool dependent)

Returns
the preview maximum distance builder
Created in NX11.0.1.

License requirements : None
double NXOpen::CAM::InterpolateVector::GetTiltAngle ( int  index)

Get the Tilt angle.

Returns
the tilt angle
Created in NX11.0.1.

License requirements : cam_base ("CAM BASE")
Parameters
indexthe index of item
NXOpen::Direction* NXOpen::CAM::InterpolateVector::GetVector ( int  index)

Get the vector.

Returns
the vector
Created in NX7.5.5.

License requirements : None
Parameters
indexthe index of item
void NXOpen::CAM::InterpolateVector::Insert ( int  inputIndex,
NXOpen::Point point,
NXOpen::NXObject view,
NXOpen::Direction vector 
)

Add a new item
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
inputIndexthe new created item index
pointthe point
viewthe view
vectorthe vector
double NXOpen::CAM::InterpolateVector::MinimumLeadAngle ( )

Returns the minimum lead angle
Created in NX8.5.0.



License requirements : None

void NXOpen::CAM::InterpolateVector::Modify ( int  index,
NXOpen::Point point,
NXOpen::Direction vector 
)

Modify an existing item by index
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
indexthe index of modified item
pointthe point
vectorthe vector
void NXOpen::CAM::InterpolateVector::Modify ( int  index,
NXOpen::Point point,
NXOpen::Direction vector,
bool  ignorePoint 
)

Modify an existing item by index
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
indexthe index of modified item
pointthe point
vectorthe vector
ignorePointthe status of the point
void NXOpen::CAM::InterpolateVector::MoveDown ( int  index)

Move down an item
Created in NX7.5.0.



License requirements : None

Parameters
indexthe index of item which should be moved down
void NXOpen::CAM::InterpolateVector::MoveUp ( int  index)

Move up an item
Created in NX7.5.0.



License requirements : None

Parameters
indexthe index of item which should be moved up
void NXOpen::CAM::InterpolateVector::SetApplyLeadTilt ( bool  applyLeadTilt)

Sets a boolean value that indicates whether the lead and tilt angles needs to be given more precedence
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
applyLeadTiltthe apply lead tilt value
void NXOpen::CAM::InterpolateVector::SetLeadAngle ( int  index,
double  leadAngle 
)

Set the lead angle
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
indexthe index of item
leadAnglethe lead angle
void NXOpen::CAM::InterpolateVector::SetMinimumLeadAngle ( double  minLeadAngle)

Sets the minimum lead angle
Created in NX8.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
minLeadAnglethe minimum lead angle
void NXOpen::CAM::InterpolateVector::SetSmoothingMethod ( int  smoothingOption)

Sets the smoothing method
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
smoothingOptionthe smoothing method value
void NXOpen::CAM::InterpolateVector::SetTiltAngle ( double  tiltAngle)

Sets the tilt angle
Created in NX7.5.2.



License requirements : cam_base ("CAM BASE")

Parameters
tiltAnglethe tilt angle value
void NXOpen::CAM::InterpolateVector::SetTiltAngle ( int  index,
double  tiltAngle 
)

Set the tilt angle
Created in NX11.0.1.



License requirements : cam_base ("CAM BASE")

Parameters
indexthe index of item
tiltAnglethe tilt angle
int NXOpen::CAM::InterpolateVector::SmoothingMethod ( )

Returns the smoothing method
Created in NX11.0.1.



License requirements : None

double NXOpen::CAM::InterpolateVector::TiltAngle ( )

Returns the tilt angle
Created in NX7.5.2.



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.