NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Mechatronics::PathConstraintJointBuilder Class Reference

Represents a NXOpen::Mechatronics::PathConstraintJoint builder. More...

Inheritance diagram for NXOpen::Mechatronics::PathConstraintJointBuilder:
NXOpen::Mechatronics::PhysicsJointBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PathTypes { PathTypesFromCoordinateSystems, PathTypesFromCurves }
 the path types More...
 

Public Member Functions

NXOpen::DirectionAxisVector ()
 Returns the axis vector which is tangent to the path curve at the selected point
Created in NX10.0.0. More...
 
void EvaluatePath (const std::vector< NXOpen::NXObject * > &curves)
 Evaluate the composited path with the curves. More...
 
NXOpen::Mechatronics::PathConstraintFrameBuilderListFrameList ()
 Returns the list containing the defined frames. More...
 
void GeneratePathCurves ()
 Generate the path curves from the coordinates systems. More...
 
std::vector< NXOpen::NXObject * > GetPathCurves ()
 Get the path curves that constrain the movement of the attachment. More...
 
NXOpen::Mechatronics::PathConstraintFrameBuilderNewPathFrame ()
 Creates a NXOpen::Mechatronics::PathConstraintFrameBuilder object. More...
 
bool PathPreview ()
 Returns the path preview
Created in NX10.0.0. More...
 
NXOpen::Mechatronics::PathConstraintJointBuilder::PathTypes PathType ()
 Returns the path type. More...
 
NXOpen::PointPointOnCurve ()
 Returns the selected point on curve
Created in NX10.0.0. More...
 
void SetAxisVector (NXOpen::Direction *axisVector)
 Sets the axis vector which is tangent to the path curve at the selected point
Created in NX10.0.0. More...
 
void SetPathCurvesFromCurves (const std::vector< NXOpen::NXObject * > &pathCurves)
 Set the path curves that constrain the movement of the attachment
Created in NX10.0.0. More...
 
void SetPathPreview (bool enable)
 Sets the path preview
Created in NX10.0.0. More...
 
void SetPathType (NXOpen::Mechatronics::PathConstraintJointBuilder::PathTypes pathType)
 Sets the path type. More...
 
void SetPointOnCurve (NXOpen::Point *pointOnCurve)
 Sets the selected point on curve
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::PhysicsJointBuilder
NXOpen::SelectNXObjectAttachment ()
 Returns the attachment of joint. More...
 
NXOpen::SelectNXObjectBase ()
 Returns the base of joint. More...
 
NXOpen::PointBaseAnchorPoint ()
 Returns. More...
 
NXOpen::DirectionBaseAxisVector ()
 Returns. More...
 
NXString Name ()
 Returns the name. More...
 
bool Positioning ()
 Returns. More...
 
void SetAttachment (NXOpen::NXObject *attachment)
 Sets the attachment. More...
 
void SetBase (NXOpen::NXObject *base)
 Sets the base. More...
 
void SetBaseAnchorPoint (NXOpen::Point *point)
 Sets. More...
 
void SetBaseAxisVector (NXOpen::Direction *axisVector)
 Sets. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. More...
 
void SetPositioning (bool usePositioning)
 Sets. 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

Represents a NXOpen::Mechatronics::PathConstraintJoint builder.


To create a new instance of this class, use NXOpen::Mechatronics::PathConstraintJointCollection::CreatePathConstraintJointBuilder

Created in NX10.0.0.

Member Enumeration Documentation

the path types

Enumerator
PathTypesFromCoordinateSystems 

from coordinate systems

PathTypesFromCurves 

from curves

Member Function Documentation

NXOpen::Direction* NXOpen::Mechatronics::PathConstraintJointBuilder::AxisVector ( )

Returns the axis vector which is tangent to the path curve at the selected point
Created in NX10.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::PathConstraintJointBuilder::EvaluatePath ( const std::vector< NXOpen::NXObject * > &  curves)

Evaluate the composited path with the curves.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
curvescurve or edge
NXOpen::Mechatronics::PathConstraintFrameBuilderList* NXOpen::Mechatronics::PathConstraintJointBuilder::FrameList ( )

Returns the list containing the defined frames.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::PathConstraintJointBuilder::GeneratePathCurves ( )

Generate the path curves from the coordinates systems.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

std::vector<NXOpen::NXObject *> NXOpen::Mechatronics::PathConstraintJointBuilder::GetPathCurves ( )

Get the path curves that constrain the movement of the attachment.

Returns
curve or edge
Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
NXOpen::Mechatronics::PathConstraintFrameBuilder* NXOpen::Mechatronics::PathConstraintJointBuilder::NewPathFrame ( )

Creates a NXOpen::Mechatronics::PathConstraintFrameBuilder object.

Returns

Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
bool NXOpen::Mechatronics::PathConstraintJointBuilder::PathPreview ( )

Returns the path preview
Created in NX10.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::PathConstraintJointBuilder::PathTypes NXOpen::Mechatronics::PathConstraintJointBuilder::PathType ( )

Returns the path type.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Point* NXOpen::Mechatronics::PathConstraintJointBuilder::PointOnCurve ( )

Returns the selected point on curve
Created in NX10.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::PathConstraintJointBuilder::SetAxisVector ( NXOpen::Direction axisVector)

Sets the axis vector which is tangent to the path curve at the selected point
Created in NX10.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
axisVectoraxisvector
void NXOpen::Mechatronics::PathConstraintJointBuilder::SetPathCurvesFromCurves ( const std::vector< NXOpen::NXObject * > &  pathCurves)

Set the path curves that constrain the movement of the attachment
Created in NX10.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathCurvescurve or edge
void NXOpen::Mechatronics::PathConstraintJointBuilder::SetPathPreview ( bool  enable)

Sets the path preview
Created in NX10.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
enableenable
void NXOpen::Mechatronics::PathConstraintJointBuilder::SetPathType ( NXOpen::Mechatronics::PathConstraintJointBuilder::PathTypes  pathType)

Sets the path type.


Created in NX10.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pathTypepathtype
void NXOpen::Mechatronics::PathConstraintJointBuilder::SetPointOnCurve ( NXOpen::Point pointOnCurve)

Sets the selected point on curve
Created in NX10.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
pointOnCurvepointoncurve

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.