the AlongPath pattern definition. More...

Inheritance diagram for NXOpen::GeometricUtilities::AlongPathPattern:

Public Types
enum	PathOptions { PathOptionsRigid, PathOptionsOffset, PathOptionsTranslate }
	This defines path options. More...

enum	YDirectionOptions { YDirectionOptionsVector, YDirectionOptionsSection }
	This defines y direction Types. More...

Public Member Functions
void	SetUseYDirectionToggle (bool toggle)
	Sets the UseYDirection toggle attribute. More...

void	SetXPath (NXOpen::Section *xPath)
	Sets the x path Created in NX7.5.0. More...

void	SetXPathOption (NXOpen::GeometricUtilities::AlongPathPattern::PathOptions xPathOption)
	Sets the x path options Created in NX8.0.0. More...

void	SetYDirection (NXOpen::Direction *yDirection)
	Sets the y axis, which can be any vector not parallel to the x axis Created in NX7.5.0. More...

void	SetYDirectionOption (NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOptions yDirectionOption)
	Sets the y direction options Created in NX7.5.0. More...

void	SetYPath (NXOpen::Section *yPath)
	Sets the y path, which can be any continuous section Created in NX7.5.0. More...

void	SetYPathOption (NXOpen::GeometricUtilities::AlongPathPattern::PathOptions yPathOption)
	Sets the y path options Created in NX8.0.0. More...

bool	UseYDirectionToggle ()
	Returns the UseYDirection toggle attribute. More...

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

NXOpen::GeometricUtilities::OnPathDistancePatternSpacing *	XOnPathSpacing ()
	Returns the on path instance spacing along the x path Created in NX7.5.0. More...

NXOpen::Section *	XPath ()
	Returns the x path Created in NX7.5.0. More...

NXOpen::GeometricUtilities::AlongPathPattern::PathOptions	XPathOption ()
	Returns the x path options Created in NX8.0.0. More...

NXOpen::Direction *	YDirection ()
	Returns the y axis, which can be any vector not parallel to the x axis Created in NX7.5.0. More...

NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOptions	YDirectionOption ()
	Returns the y direction options Created in NX7.5.0. More...

NXOpen::GeometricUtilities::OnPathDistancePatternSpacing *	YOnPathSpacing ()
	Returns the on path instance spacing along the y path Created in NX7.5.0. More...

NXOpen::Section *	YPath ()
	Returns the y path, which can be any continuous section Created in NX7.5.0. More...

NXOpen::GeometricUtilities::AlongPathPattern::PathOptions	YPathOption ()
	Returns the y path options Created in NX8.0.0. More...

NXOpen::GeometricUtilities::DistancePatternSpacing *	YSpacing ()
	Returns the instance spacing along the y axis Created in NX7.5.0. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

the AlongPath pattern definition.

Allows specification along two section pathes.
Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::AlongPathPattern::PathOptions

This defines path options.

Enumerator
PathOptionsRigid	path is the selected section.
PathOptionsOffset	path is an offset from the selected path.
PathOptionsTranslate	path is a translation from the selected path.

enum NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOptions

This defines y direction Types.

Enumerator
YDirectionOptionsVector	y direction is a vector.
YDirectionOptionsSection	y direction is a section.

Member Function Documentation

void NXOpen::GeometricUtilities::AlongPathPattern::SetUseYDirectionToggle ( bool toggle )

Sets the UseYDirection toggle attribute.

This function gets the UseYDirection toggle value
Created in NX7.5.0.

License requirements : None

Parameters

toggle toggle

void NXOpen::GeometricUtilities::AlongPathPattern::SetXPath ( NXOpen::Section * xPath )

Sets the x path
Created in NX7.5.0.

License requirements : None

Parameters

xPath xpath

void NXOpen::GeometricUtilities::AlongPathPattern::SetXPathOption ( NXOpen::GeometricUtilities::AlongPathPattern::PathOptions xPathOption )

Sets the x path options
Created in NX8.0.0.

License requirements : None

Parameters

xPathOption xpathoption

void NXOpen::GeometricUtilities::AlongPathPattern::SetYDirection ( NXOpen::Direction * yDirection )

Sets the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.

License requirements : None

Parameters

yDirection ydirection

void NXOpen::GeometricUtilities::AlongPathPattern::SetYDirectionOption ( NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOptions yDirectionOption )

Sets the y direction options
Created in NX7.5.0.

License requirements : None

Parameters

yDirectionOption ydirectionoption

void NXOpen::GeometricUtilities::AlongPathPattern::SetYPath ( NXOpen::Section * yPath )

Sets the y path, which can be any continuous section
Created in NX7.5.0.

License requirements : None

Parameters

yPath ypath

void NXOpen::GeometricUtilities::AlongPathPattern::SetYPathOption ( NXOpen::GeometricUtilities::AlongPathPattern::PathOptions yPathOption )

Sets the y path options
Created in NX8.0.0.

License requirements : None

Parameters

yPathOption ypathoption

bool NXOpen::GeometricUtilities::AlongPathPattern::UseYDirectionToggle ( )

Returns the UseYDirection toggle attribute.

This function gets the UseYDirection toggle value
Created in NX7.5.0.

License requirements : None

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

NXOpen::GeometricUtilities::OnPathDistancePatternSpacing* NXOpen::GeometricUtilities::AlongPathPattern::XOnPathSpacing ( )

Returns the on path instance spacing along the x path
Created in NX7.5.0.

License requirements : None

NXOpen::Section* NXOpen::GeometricUtilities::AlongPathPattern::XPath ( )

Returns the x path
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::AlongPathPattern::PathOptions NXOpen::GeometricUtilities::AlongPathPattern::XPathOption ( )

Returns the x path options
Created in NX8.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricUtilities::AlongPathPattern::YDirection ( )

Returns the y axis, which can be any vector not parallel to the x axis
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOptions NXOpen::GeometricUtilities::AlongPathPattern::YDirectionOption ( )

Returns the y direction options
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::OnPathDistancePatternSpacing* NXOpen::GeometricUtilities::AlongPathPattern::YOnPathSpacing ( )

Returns the on path instance spacing along the y path
Created in NX7.5.0.

License requirements : None

NXOpen::Section* NXOpen::GeometricUtilities::AlongPathPattern::YPath ( )

Returns the y path, which can be any continuous section
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::AlongPathPattern::PathOptions NXOpen::GeometricUtilities::AlongPathPattern::YPathOption ( )

Returns the y path options
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::DistancePatternSpacing* NXOpen::GeometricUtilities::AlongPathPattern::YSpacing ( )

Returns the instance spacing along the y axis
Created in NX7.5.0.

License requirements : None

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

GeometricUtilities_AlongPathPattern.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation