Represents a Motion::SplineBeamBuilder builder
To create a new instance of this class, use NXOpen::Motion::SplineBeamCollection::CreateSplineBeamBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::SplineBeamBuilder:

Public Types
enum	DefinitionMethodType { DefinitionMethodTypeManual, DefinitionMethodTypeCurve }
	the definition method type More...

enum	SectionAxisType { SectionAxisTypeY, SectionAxisTypeZ }
	the definition of the section axis type More...

Public Member Functions
void	AssignPoint (int index, NXOpen::Point *point)
	Assigns a point Created in NX12.0.0. More...

NXOpen::Motion::MarkerToNodeData *	CreateMarkerToNode (NXOpen::NXObject *marker, int markerPosition, int pointID, bool useClosestNode)
	Creates a new list item. More...

NXOpen::SelectCurveList *	Curves ()
	Returns the optional curves object Created in NX12.0.0. More...

NXOpen::Motion::SplineBeamBuilder::DefinitionMethodType	DefinitionMethod ()
	Returns the definition method Created in NX12.0.0. More...

void	ExportPointsToFile (const NXString &filePath)
	Exports the points to an external file. More...

void	ExportPointsToFile (const char *filePath)
	Exports the points to an external file. More...

void	GeneratePoints ()
	Generates the points Created in NX12.0.0. More...

std::vector < NXOpen::Motion::MarkerToNodeData * >	GetMarkerItems ()
	Gets marker to node list Items. More...

void	ImportPointsFromFile (const NXString &filePath)
	Imports the points from an external file. More...

void	ImportPointsFromFile (const char *filePath)
	Imports the points from an external file. More...

void	InsertEmptyPoint (int index)
	Inserts an empty point to a location Created in NX12.0.0. More...

NXOpen::Motion::SelectLink *	Link ()
	Returns the link object Created in NX12.0.0. More...

NXString	Name ()
	Returns the name of the spline beam object Created in NX12.0.0. More...

NXOpen::Expression *	NumberOfSections ()
	Returns the number of sections Created in NX12.0.0. More...

NXOpen::PointList *	PointList ()
	Returns the list of points Created in NX12.0.0. More...

void	RemoveAllMarkers ()
	Removes all markers Created in NX12.0.0. More...

void	RemovePoint (int index)
	Removes a point Created in NX12.0.0. More...

NXOpen::Motion::SplineBeamBuilder::SectionAxisType	SectionAxis ()
	Returns the section orientation axis type Created in NX12.0.0. More...

NXOpen::Motion::SelectBaseSection *	SectionShape ()
	Returns the section shape Created in NX12.0.0. More...

NXOpen::Direction *	SectionVector ()
	Returns the section orientation vector Created in NX12.0.0. More...

void	SetDefinitionMethod (NXOpen::Motion::SplineBeamBuilder::DefinitionMethodType type)
	Sets the definition method Created in NX12.0.0. More...

void	SetName (const NXString &name)
	Sets the name of the spline beam object Created in NX12.0.0. More...

void	SetName (const char *name)
	Sets the name of the spline beam object Created in NX12.0.0. More...

void	SetSectionAxis (NXOpen::Motion::SplineBeamBuilder::SectionAxisType type)
	Sets the section orientation axis type Created in NX12.0.0. More...

void	SetSectionVector (NXOpen::Direction *vector)
	Sets the section orientation vector Created in NX12.0.0. More...

NXOpen::Motion::SelectSplineBeamProperty *	StructuralProperty ()
	Returns the structural property Created in NX12.0.0. More...

void	SwapPoints (int index1, int index2)
	Swaps two points Created in NX12.0.0. More...

NXOpen::Expression *	Tolerance ()
	Returns the tolerance Created in NX12.0.0. More...

Public Member Functions inherited from NXOpen::Motion::MotionBuilder
double	DisplayScale ()
	Returns the icon display scale Created in NX5.0.0. More...

NXString	GroupName ()
	Returns the group name Created in NX5.0.0. More...

NXOpen::Motion::MotionObject::GroupType	GroupType ()
	Returns the group type Created in NX5.0.0. More...

void	SetDisplayScale (double displayScale)
	Sets the icon display scale Created in NX5.0.0. More...

void	SetGroupName (const NXString &groupName)
	Sets the group name Created in NX5.0.0. More...

void	SetGroupName (const char *groupName)
	Sets the group name Created in NX5.0.0. More...

void	SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType)
	Sets the group type Created in NX5.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 Motion::SplineBeamBuilder builder
To create a new instance of this class, use NXOpen::Motion::SplineBeamCollection::CreateSplineBeamBuilder
Default values.

Property

Value

DefinitionMethod

Manual

NumberOfSections.Value

1

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Motion::SplineBeamBuilder::DefinitionMethodType

the definition method type

Enumerator
DefinitionMethodTypeManual	Manual.
DefinitionMethodTypeCurve	Curve.

enum NXOpen::Motion::SplineBeamBuilder::SectionAxisType

the definition of the section axis type

Enumerator
SectionAxisTypeY	Y Vector.
SectionAxisTypeZ	Z Vector.

Member Function Documentation

void NXOpen::Motion::SplineBeamBuilder::AssignPoint	(	int	index,
		NXOpen::Point *	point
	)

Assigns a point
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

index	index
point	point

NXOpen::Motion::MarkerToNodeData* NXOpen::Motion::SplineBeamBuilder::CreateMarkerToNode	(	NXOpen::NXObject *	marker,
		int	markerPosition,
		int	pointID,
		bool	useClosestNode
	)

Creates a new list item.

Returns: Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

marker	The marker tag
markerPosition	The i or j marker identity
pointID	The point ID
useClosestNode	Whether to move the node

NXOpen::SelectCurveList* NXOpen::Motion::SplineBeamBuilder::Curves ( )

Returns the optional curves object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SplineBeamBuilder::DefinitionMethodType NXOpen::Motion::SplineBeamBuilder::DefinitionMethod ( )

Returns the definition method
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::SplineBeamBuilder::ExportPointsToFile ( const NXString & filePath )

Exports the points to an external file.

Allowed file types are .txt and Excel files
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

filePath filepath

void NXOpen::Motion::SplineBeamBuilder::ExportPointsToFile ( const char * filePath )

Exports the points to an external file.

Allowed file types are .txt and Excel files
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

filePath filepath

void NXOpen::Motion::SplineBeamBuilder::GeneratePoints ( )

Generates the points
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

std::vector<NXOpen::Motion::MarkerToNodeData *> NXOpen::Motion::SplineBeamBuilder::GetMarkerItems ( )

Gets marker to node list Items.

Returns: Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::SplineBeamBuilder::ImportPointsFromFile ( const NXString & filePath )

Imports the points from an external file.

Allowed file types are .txt and Excel files
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

filePath filepath

void NXOpen::Motion::SplineBeamBuilder::ImportPointsFromFile ( const char * filePath )

Imports the points from an external file.

Allowed file types are .txt and Excel files
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

filePath filepath

void NXOpen::Motion::SplineBeamBuilder::InsertEmptyPoint ( int index )

Inserts an empty point to a location
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

index index

NXOpen::Motion::SelectLink* NXOpen::Motion::SplineBeamBuilder::Link ( )

Returns the link object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::SplineBeamBuilder::Name ( )

Returns the name of the spline beam object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::SplineBeamBuilder::NumberOfSections ( )

Returns the number of sections
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::PointList* NXOpen::Motion::SplineBeamBuilder::PointList ( )

Returns the list of points
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::SplineBeamBuilder::RemoveAllMarkers ( )

Removes all markers
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::SplineBeamBuilder::RemovePoint ( int index )

Removes a point
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

index index

NXOpen::Motion::SplineBeamBuilder::SectionAxisType NXOpen::Motion::SplineBeamBuilder::SectionAxis ( )

Returns the section orientation axis type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::SelectBaseSection* NXOpen::Motion::SplineBeamBuilder::SectionShape ( )

Returns the section shape
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

NXOpen::Direction* NXOpen::Motion::SplineBeamBuilder::SectionVector ( )

Returns the section orientation vector
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::SplineBeamBuilder::SetDefinitionMethod ( NXOpen::Motion::SplineBeamBuilder::DefinitionMethodType type )

Sets the definition method
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type type

void NXOpen::Motion::SplineBeamBuilder::SetName ( const NXString & name )

Sets the name of the spline beam object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::SplineBeamBuilder::SetName ( const char * name )

Sets the name of the spline beam object
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

name name

void NXOpen::Motion::SplineBeamBuilder::SetSectionAxis ( NXOpen::Motion::SplineBeamBuilder::SectionAxisType type )

Sets the section orientation axis type
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

type type

void NXOpen::Motion::SplineBeamBuilder::SetSectionVector ( NXOpen::Direction * vector )

Sets the section orientation vector
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

vector vector

NXOpen::Motion::SelectSplineBeamProperty* NXOpen::Motion::SplineBeamBuilder::StructuralProperty ( )

Returns the structural property
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::SplineBeamBuilder::SwapPoints	(	int	index1,
		int	index2
	)

Swaps two points
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters

index1	index1
index2	index2

NXOpen::Expression* NXOpen::Motion::SplineBeamBuilder::Tolerance ( )

Returns the tolerance
Created in NX12.0.0.

License requirements : mechanisms ("MECHANISMS")

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

Motion_SplineBeamBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation