Assembly Class
The commands in the Assembly class are described below.
. More...

Inherits ItemObject.

Public Member Functions
virtual void	AddPropertyByReference (String &name, ReferenceObject *value)
	Adds ReferenceObject object to a specified variable. More...

AssemblyCircularPattern *	CreateAssemblyCircularPattern ()
	Creates a circular pattern in the assembly. More...

AssemblyLinearPattern *	CreateAssemblyLinearPattern ()
	Creates a linear pattern in the assembly. More...

AssemblyMirrorCopy *	CreateAssemblyMirrorCopy ()
	Creates a mirror copy in the assembly. More...

AssemblyConstraintObject *	CreateBiConstraint (Variant &value, ReferenceObject ref, ReferenceObject ref2)
	Specifies constraint (constraint with 2 targets). More...

AssemblyBoolean *	CreateBoolean ()
	Runs Assembly Boolean. More...

CompositePath *	CreateCompositePath ()
	Creates a composite path. More...

AssemblyConstraintObject *	CreateConstraint (Variant &value)
	Specifies 3D constraint (constraint with multiple target). More...

AssemblyMergeNode *	CreateDeleteDuplicatedNodes ()
	Deletes duplicate nodes. More...

ExtrudeCut *	CreateExtrudeCut (Sketch *sketch, double height)
	Creates an extrude cut in the assembly. More...

ExtrudeSplit *	CreateExtrudeSplit (Sketch *sketch, double height)
	Creates an extrude split in the assembly. More...

HelixPath *	CreateHelixPath ()
	Creates a helix path. More...

AssemblyImprint *	CreateImprint ()
	Runs Imprint between parts. More...

MeshPart *	CreateMeshPart (ReferenceObject *reference)
	Creates a mesh part based on the mesh included in ReferenceObject (sketch, part). More...

AssemblyConstraintObject *	CreateMonoConstraint (Variant &value, ReferenceObject *ref)
	Specifies constraint (constraint with 1 target). More...

Part *	CreatePart ()
	Creates a part under the assembly. More...

PointsPath *	CreatePointsPath ()
	Creates a pointes path. More...

ReferenceLine *	CreateReferenceLine ()
	Creates a reference line. More...

ReferencePlane *	CreateReferencePlane ()
	Creates a reference plane. More...

ReferencePoint *	CreateReferencePoint ()
	Creates a reference point. More...

RevolveCut *	CreateRevolveCut (Sketch *sketch)
	Creates a revolve cut in the assembly. More...

RevolveSplit *	CreateRevolveSplit (Sketch *sketch)
	Creates a revolve split in the assembly. More...

AssemblyScale *	CreateScale ()
	Enlarges or shrinks the assembly. More...

Sketch *	CreateSketch (ReferenceObject *reference=0)
	Creates a 2D sketch under the assembly. More...

SpiralPath *	CreateSpiralPath ()
	Creates a spiral path. More...

SweepCut *	CreateSweepCut (Sketch *sketch)
	Creates a sweep cut in the assembly. More...

SweepSplit *	CreateSweepSplit (Sketch *sketch)
	Creates a sweep split in the assembly. More...

VerticesPath *	CreateVerticesPath ()
	Creates a vertices path. More...

ItemObject *	GetItem (Variant &value)
	Returns an item displayed in the [Model Manager] tree such as assembly, part and sketch. Index is numbered in the order of the each items shown in the tree. More...

String	GetName ()
	Returns a name. More...

ReferenceObject *	GetPlaneXY ()
	Returns the XY-plane under the assembly. More...

ReferenceObject *	GetPlaneYZ ()
	Returns the YZ-plane under the assembly. More...

ReferenceObject *	GetPlaneZX ()
	Returns the ZX-plane under the assembly. More...

virtual Variant	GetProperty (String &name)
	Returns the value of the property with the specified name. More...

String	GetScriptTypeName ()
	Returns the name of the object type as a string. More...

bool	IsKeepMeshIds ()
	Returns True if the rule of keeping mesh ids to inherit condition/material is applied. More...

virtual bool	IsValid ()
	Returns True if an object is valid. More...

Part *	MoveToPart (ReferenceObject *reference)
	Moves a 2D sketch that is under [assembly] under a new part. More...

int	NumItems ()
	Returns the number of items. More...

void	OpenAssembly ()
	Starts editing an assembly.

void	SetName (String &name)
	Specifies a name. More...

virtual void	SetProperty (String &name, Variant &value)
	Specifies a value of property. More...

virtual void	SetPropertyByReference (String &name, ReferenceObject *value)
	Specifies the values in properties by ReferenceObject object. More...

Detailed Description

Assembly Class
The commands in the Assembly class are described below.
.

The Assembly class which is under the ItemObject class, includes commands to control the assembly with Geometry Editor.

Commands related to create a part
Commands related to create a 2D sketch
Commands related to create a reference line, reference plane, and reference point
Commands related to delete duplicated nodes in the assembly
Commands related to extrude cut in the assembly
Commands related to extrude split in the assembly
Commands related to revolve cut in the assembly
Commands related to revolve split in the assembly
Commands related to imprint for parts
Commands related to boolean for parts
Commands related to convert to mesh part
For more information about the properties for this class, see here .

Member Function Documentation

void ItemObject::AddPropertyByReference	(	String &	name,
		ReferenceObject *	value
	)

virtualinherited

Adds ReferenceObject object to a specified variable.

Parameters

name	Property name
value	ReferenceObject object (target)

AssemblyCircularPattern * Assembly::CreateAssemblyCircularPattern ( )

Creates a circular pattern in the assembly.

Returns: AssemblyCircularPattern object

AssemblyLinearPattern * Assembly::CreateAssemblyLinearPattern ( )

Creates a linear pattern in the assembly.

Returns: AssemblyLinearPattern object

AssemblyMirrorCopy * Assembly::CreateAssemblyMirrorCopy ( )

Creates a mirror copy in the assembly.

Returns: AssemblyMirrorCopy object

AssemblyConstraintObject * Assembly::CreateBiConstraint	(	Variant &	value,
		ReferenceObject *	ref,
		ReferenceObject *	ref2
	)

Specifies constraint (constraint with 2 targets).

Parameters

value	Types of constraints 2="distance"：Distance 3="concentricity"：Coincident 4="tangency"：Tangency 5="angle"：Angle 6="parallelism"：Parallelism 8="perpendicularity"：Perpendicularity 10="coincident"：Coincident
ref	ReferenceObject object
ref2	ReferenceObject object

Returns: AssemblyConstraintObject object

For more information about AssemblyConstraintObject properies, see " Properties for 3D Constraint ".

AssemblyBoolean * Assembly::CreateBoolean ( )

Runs Assembly Boolean.

Returns: AssemblyBoolean object

CompositePath * Assembly::CreateCompositePath ( )

Creates a composite path.

Returns: CompositePath object

AssemblyConstraintObject * Assembly::CreateConstraint ( Variant & value )

Specifies 3D constraint (constraint with multiple target).

Parameters

value

Types of constraints
1="fixture" ： Fixture
2="distance"：Distance 
9="verticality"：Verticality 

Returns: AssemblyConstraintObject object

For more information about AssemblyConstraintObject properies, see " Properties for 3D Constraint ".

AssemblyMergeNode * Assembly::CreateDeleteDuplicatedNodes ( )

Deletes duplicate nodes.

Returns: AssemblyMergeNode object

ExtrudeCut * Assembly::CreateExtrudeCut	(	Sketch *	sketch,
		double	height
	)

Creates an extrude cut in the assembly.

Parameters

sketch	Sketch Object
height	Height of a piece to be extruded from a part

Returns: ExtrudeCut object

ExtrudeSplit * Assembly::CreateExtrudeSplit	(	Sketch *	sketch,
		double	height
	)

Creates an extrude split in the assembly.

Parameters

sketch	Sketch object
height	Height of extrude split

Returns: ExtrudeSplit object

HelixPath * Assembly::CreateHelixPath ( )

Creates a helix path.

Returns: HelixPath object

AssemblyImprint * Assembly::CreateImprint ( )

Runs Imprint between parts.

Returns: AssemblyImprint object

MeshPart * Assembly::CreateMeshPart ( ReferenceObject * reference )

Creates a mesh part based on the mesh included in ReferenceObject (sketch, part).

Parameters

reference ReferenceObject object

Returns: MeshPart object

AssemblyConstraintObject * Assembly::CreateMonoConstraint	(	Variant &	value,
		ReferenceObject *	ref
	)

Specifies constraint (constraint with 1 target).

Parameters

value	Types of constraints 1="fixture" ： Fixture
ref	ReferenceObject object

Returns: AssemblyConstraintObject object

For more information about AssemblyConstraintObject properies, see " Properties for 3D Constraint ".

Part * Assembly::CreatePart ( )

Creates a part under the assembly.

Returns: Part object

PointsPath * Assembly::CreatePointsPath ( )

Creates a pointes path.

Returns: PointsPath object

ReferenceLine * Assembly::CreateReferenceLine ( )

Creates a reference line.

Returns: ReferenceLine object

ReferencePlane * Assembly::CreateReferencePlane ( )

Creates a reference plane.

Returns: ReferencePlane object

ReferencePoint * Assembly::CreateReferencePoint ( )

Creates a reference point.

Returns: ReferencePoint object

RevolveCut * Assembly::CreateRevolveCut ( Sketch * sketch )

Creates a revolve cut in the assembly.

Parameters

sketch Sketch object

Returns: RevolveCut object

RevolveSplit * Assembly::CreateRevolveSplit ( Sketch * sketch )

Creates a revolve split in the assembly.

Parameters

sketch Sketch object

Returns: RevolveSplit object

AssemblyScale * Assembly::CreateScale ( )

Enlarges or shrinks the assembly.

Returns: AssemblyScale object

Sketch * Assembly::CreateSketch ( ReferenceObject * reference = 0 )

Creates a 2D sketch under the assembly.

Parameters

reference ReferenceObject object

Returns: Sketch object

SpiralPath * Assembly::CreateSpiralPath ( )

Creates a spiral path.

Returns: SpiralPath object

SweepCut * Assembly::CreateSweepCut ( Sketch * sketch )

Creates a sweep cut in the assembly.

Parameters

sketch Sketch object

Returns: SweepCut object

SweepSplit * Assembly::CreateSweepSplit ( Sketch * sketch )

Creates a sweep split in the assembly.

Parameters

sketch Sketch object

Returns: SweepSplit object

VerticesPath * Assembly::CreateVerticesPath ( )

Creates a vertices path.

Returns: VerticesPath object

ItemObject * ItemObject::GetItem ( Variant & value )

inherited

Returns an item displayed in the [Model Manager] tree such as assembly, part and sketch. Index is numbered in the order of the each items shown in the tree.

Parameters

value Item name or index

Returns: ItemObject object

String ItemObject::GetName ( )

inherited

Returns a name.

Returns: Item name

ReferenceObject * Assembly::GetPlaneXY ( )

Returns the XY-plane under the assembly.

Returns: ReferencePlane object

ReferenceObject * Assembly::GetPlaneYZ ( )

Returns the YZ-plane under the assembly.

Returns: ReferencePlane object

ReferenceObject * Assembly::GetPlaneZX ( )

Returns the ZX-plane under the assembly.

Returns: ReferencePlane object

Variant ItemObject::GetProperty ( String & name )

virtualinherited

Returns the value of the property with the specified name.

Parameters

name	Property name

Returns: Value of properties

String ItemObject::GetScriptTypeName ( )

inherited

Returns the name of the object type as a string.

Returns: Type name of object

bool Assembly::IsKeepMeshIds ( )

Returns True if the rule of keeping mesh ids to inherit condition/material is applied.

Returns: Whether to be applied the rule of keeping mesh ids

bool ItemObject::IsValid ( )

virtualinherited

Returns True if an object is valid.

Returns: Whether or not the object are valid

Reimplemented in Sketch, Part, SketchItem, and MeshPart.

Part * Assembly::MoveToPart ( ReferenceObject * reference )

Moves a 2D sketch that is under [assembly] under a new part.

Parameters

reference ReferenceObject object

Returns: Part object

int ItemObject::NumItems ( )

inherited

Returns the number of items.

Returns: Item count

void ItemObject::SetName ( String & name )

inherited

Specifies a name.

Parameters

name Item name

void ItemObject::SetProperty	(	String &	name,
		Variant &	value
	)

virtualinherited

Specifies a value of property.

Parameters

name	Property name
value	Value of properties

Reimplemented in SketchItem.

void ItemObject::SetPropertyByReference	(	String &	name,
		ReferenceObject *	value
	)

virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters

name	Property name
value	ReferenceObject object (target)

Public Member Functions

Detailed Description

Member Function Documentation