Part Class
The commands in the Part 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...

void	ClosePart ()
	Ends editing a part.

PartBoolean *	CreateBoolean ()
	Runs Boolean between solids (boolean in the same part). More...

SolidCircularPattern *	CreateCircularPattern ()
	Creates copies of the solid in the circumferential direction. More...

CoilTemplate *	CreateCoilTemplate ()
	Creates a solid for coils using coil templates. More...

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

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

EdgeChamfer *	CreateEdgeChamfer ()
	Chamfers the edge of the solid. More...

EdgeFillet *	CreateEdgeFillet ()
	Creates fillets to solid edges. More...

ExtrudeCut *	CreateExtrudeCut (Sketch *sketch, double height=10.0)
	Proceses solids by setting a Extrude Cut feature to a sketch. More...

ExtrudeImprint *	CreateExtrudeImprint (Sketch *sketch, double height=10.0)
	Imprints a piece from the solid. More...

ExtrudeSolid *	CreateExtrudeSolid (Sketch *sketch, double height=10.0)
	Creates solids by setting a Extrude feature to a sketch. More...

ExtrudeSplit *	CreateExtrudeSplit (Sketch *sketch, double height=10.0)
	Proceses solids by setting a Extrude Split feature to a sketch. More...

ExtrudeSurface *	CreateExtrudeSurface (Sketch *sketch, double height=10.0)
	Creates shells by setting a Extrude feature to a sketch. More...

FaceExtrudeSolid *	CreateFaceExtrudeSolid ()
	Creates solids by setting a Face Extrude feature. More...

FaceRevolveSolid *	CreateFaceRevolveSolid ()
	Creates solids by setting a Face Revolve feature. More...

FaceSweepSolid *	CreateFaceSweepSolid ()
	Creates solids by setting a Face Sweep feature. More...

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

Imprint *	CreateImprint ()
	Runs imprint between solids that are in parts. More...

SolidLinearPattern *	CreateLinearPattern ()
	Creates copies of the solid in the horizontal or vertical direction. More...

MakeBeam *	CreateMakeBeam (Sketch *sketch)
	Creates beams by setting a Beam feature to a sketch. More...

SolidMirrorCopy *	CreateMirrorCopy ()
	Creates mirror copies of the solid. More...

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

SolidCircularPattern *	CreateRadialPattern ()
	Creates copies of the solid in the circumferential direction. More...

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

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

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

RevolveCut *	CreateRevolveCut (Sketch *sketch)
	Proceses solids by setting a Revolve Cut feature to a sketch. More...

RevolveSolid *	CreateRevolveSolid (Sketch *sketch)
	Creates solids by setting a Revolve feature to a sketch. More...

RevolveSplit *	CreateRevolveSplit (Sketch *sketch)
	Proceses solids by setting a Revolve Split feature to a sketch. More...

RevolveSurface *	CreateRevolveSurface (Sketch *sketch)
	Creates shells by setting a Revolve Surface feature to a sketch. More...

PartScale *	CreateScale ()
	Enlarges or shrinks parts. More...

Sketch *	CreateSketch (ReferenceObject *reference)
	Creates a sketch in part. More...

SolidFaceMove *	CreateSolidFaceMove ()
	Moves the solid faces by setting a Solid Face Move feature. More...

SolidFaceOffset *	CreateSolidFaceOffset ()
	Offsets the solid faces by setting a Solid Face Offset feature. More...

SolidMove *	CreateSolidMove ()
	Moves the solids by setting a Solid Move feature. More...

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

SweepCut *	CreateSweepCut (Sketch *sketch)
	Proceses solids by setting a Sweep Cut feature to a sketch. More...

SweepSolid *	CreateSweepSolid (Sketch *sketch)
	Creates solids by setting a Sweep feature to a sketch. More...

SweepSplit *	CreateSweepSplit (Sketch *sketch)
	Proceses solids by setting a Sweep Split feature to a sketch. More...

SweepSurface *	CreateSweepSurface (Sketch *sketch)
	Creates shells by setting a Sweep Surface feature to a sketch. More...

UserDefinedSolidTemplate *	CreateUserDefinedSolidTemplate ()
	Creates a user defined solid template. More...

VerticesPath *	CreateVerticesPath ()
	Creates a vertices path in a part. 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 reference of the XY-plane. More...

ReferenceObject *	GetPlaneYZ ()
	Returns the reference of the YZ-plane. More...

ReferenceObject *	GetPlaneZX ()
	Returns the reference of the ZX-plane. 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	IsValid ()
	Returns True if an object is valid. More...

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

void	OpenPart ()
	Starts editing a part.

void	SetColor (int red, int blue, int green)
	Specifies a color for a part. More...

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

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

The Part class includes the commands for the following operation.

Commands related to control the edit mode
Commands related to creating a sketch in part
Commands related to setting 3D feature
Commands related to create a reference line, reference plane, and reference point

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)

PartBoolean * Part::CreateBoolean ( )

Runs Boolean between solids (boolean in the same part).

Returns: PartBoolean object

SolidCircularPattern * Part::CreateCircularPattern ( )

Creates copies of the solid in the circumferential direction.

Returns: SolidCircularPattern object

CoilTemplate * Part::CreateCoilTemplate ( )

Creates a solid for coils using coil templates.

Returns: CoilTemplate object

CompositePath * Part::CreateCompositePath ( )

Creates a composite path in a part.

Returns: CompositePath object

PartMergeNode * Part::CreateDeleteDuplicatedNodes ( )

Deletes duplicate nodes.

Returns: PartMergeNode object

EdgeChamfer * Part::CreateEdgeChamfer ( )

Chamfers the edge of the solid.

Returns: EdgeChamfer object

EdgeFillet * Part::CreateEdgeFillet ( )

Creates fillets to solid edges.

Returns: EdgeFillet object

ExtrudeCut * Part::CreateExtrudeCut	(	Sketch *	sketch,
		double	height = `10.0`
	)

Proceses solids by setting a Extrude Cut feature to a sketch.

Parameters

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

Returns: ExtrudeCut object

ExtrudeImprint * Part::CreateExtrudeImprint	(	Sketch *	sketch,
		double	height = `10.0`
	)

Imprints a piece from the solid.

Parameters

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

Returns: ExtrudeImprint object

ExtrudeSolid * Part::CreateExtrudeSolid	(	Sketch *	sketch,
		double	height = `10.0`
	)

Creates solids by setting a Extrude feature to a sketch.

Parameters

sketch	Sketch object
height	Height of a piece from a part

Returns: ExtrudeSolid object

ExtrudeSplit * Part::CreateExtrudeSplit	(	Sketch *	sketch,
		double	height = `10.0`
	)

Proceses solids by setting a Extrude Split feature to a sketch.

Parameters

sketch	Sketch object
height	Height of extrude split

Returns: ExtrudeSplit object

ExtrudeSurface * Part::CreateExtrudeSurface	(	Sketch *	sketch,
		double	height = `10.0`
	)

Creates shells by setting a Extrude feature to a sketch.

Parameters

sketch	Sketch object
height	Height of a piece to be surfaced from a part

Returns: ExtrudeSurface object

FaceExtrudeSolid * Part::CreateFaceExtrudeSolid ( )

Creates solids by setting a Face Extrude feature.

Returns: FaceExtrudeSolid object

FaceRevolveSolid * Part::CreateFaceRevolveSolid ( )

Creates solids by setting a Face Revolve feature.

Returns: FaceRevolveSolid object

FaceSweepSolid * Part::CreateFaceSweepSolid ( )

Creates solids by setting a Face Sweep feature.

Returns: FaceSweepSolid object

HelixPath * Part::CreateHelixPath ( )

Creates a helix path in a part.

Returns: HelixPath object

Imprint * Part::CreateImprint ( )

Runs imprint between solids that are in parts.

Returns: Imprint object

SolidLinearPattern * Part::CreateLinearPattern ( )

Creates copies of the solid in the horizontal or vertical direction.

Returns: SolidLinearPattern object

MakeBeam * Part::CreateMakeBeam ( Sketch * sketch )

Creates beams by setting a Beam feature to a sketch.

Parameters

sketch Sketch object

Returns: MakeBeam object

SolidMirrorCopy * Part::CreateMirrorCopy ( )

Creates mirror copies of the solid.

Returns: SolidMirrorCopy object

PointsPath * Part::CreatePointsPath ( )

Creates a pointes path in a part.

Returns: PointsPath object

SolidCircularPattern * Part::CreateRadialPattern ( )

Creates copies of the solid in the circumferential direction.

Returns: SolidCircularPattern object

Deprecated:: Use CreateCircularPattern() instead.

ReferenceLine * Part::CreateReferenceLine ( )

Creates a reference line in a part.

Returns: ReferenceLine object

ReferencePlane * Part::CreateReferencePlane ( )

Creates a reference plane in a part.

Returns: ReferencePlane object

ReferencePoint * Part::CreateReferencePoint ( )

Creates a reference point in a part.

Returns: ReferencePoint object

RevolveCut * Part::CreateRevolveCut ( Sketch * sketch )

Proceses solids by setting a Revolve Cut feature to a sketch.

Parameters

sketch Sketch object

Returns: RevolveCut object

RevolveSolid * Part::CreateRevolveSolid ( Sketch * sketch )

Creates solids by setting a Revolve feature to a sketch.

Returns: RevolveSolid object

RevolveSplit * Part::CreateRevolveSplit ( Sketch * sketch )

Proceses solids by setting a Revolve Split feature to a sketch.

Parameters

sketch Sketch object

Returns: RevolveSplit object

RevolveSurface * Part::CreateRevolveSurface ( Sketch * sketch )

Creates shells by setting a Revolve Surface feature to a sketch.

Parameters

sketch Sketch object

Returns: RevolveSurface object

PartScale * Part::CreateScale ( )

Enlarges or shrinks parts.

Returns: PartScale object

Sketch * Part::CreateSketch ( ReferenceObject * reference )

Creates a sketch in part.

Parameters

reference ReferenceObject object

Returns: Sketch object

SolidFaceMove * Part::CreateSolidFaceMove ( )

Moves the solid faces by setting a Solid Face Move feature.

Returns: SolidFaceMove object

SolidFaceOffset * Part::CreateSolidFaceOffset ( )

Offsets the solid faces by setting a Solid Face Offset feature.

Returns: SolidFaceOffset object

SolidMove * Part::CreateSolidMove ( )

Moves the solids by setting a Solid Move feature.

Returns: SolidMove object

SpiralPath * Part::CreateSpiralPath ( )

Creates a spiral path in a part.

Returns: SpiralPath object

SweepCut * Part::CreateSweepCut ( Sketch * sketch )

Proceses solids by setting a Sweep Cut feature to a sketch.

Parameters

sketch Sketch object

Returns: SweepCut object

SweepSolid * Part::CreateSweepSolid ( Sketch * sketch )

Creates solids by setting a Sweep feature to a sketch.

Parameters

sketch Sketch object

Returns: SweepSolid object

SweepSplit * Part::CreateSweepSplit ( Sketch * sketch )

Proceses solids by setting a Sweep Split feature to a sketch.

Parameters

sketch Sketch object

Returns: SweepSplit object

SweepSurface * Part::CreateSweepSurface ( Sketch * sketch )

Creates shells by setting a Sweep Surface feature to a sketch.

Parameters

sketch Sketch object

Returns: SweepSurface object

UserDefinedSolidTemplate * Part::CreateUserDefinedSolidTemplate ( )

Creates a user defined solid template.

Returns: UserDefinedSolidTemplate object

VerticesPath * Part::CreateVerticesPath ( )

Creates a vertices path in a part.

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 * Part::GetPlaneXY ( )

Returns the reference of the XY-plane.

Returns: ReferenceObject object

ReferenceObject * Part::GetPlaneYZ ( )

Returns the reference of the YZ-plane.

Returns: ReferenceObject object

ReferenceObject * Part::GetPlaneZX ( )

Returns the reference of the ZX-plane.

Returns: ReferenceObject 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 Part::IsValid ( )

virtual

Returns True if an object is valid.

Returns: Whether or not the object are valid

Reimplemented from ItemObject.

int ItemObject::NumItems ( )

inherited

Returns the number of items.

Returns: Item count

void Part::SetColor	(	int	red,
		int	blue,
		int	green
	)

Specifies a color for a part.

Parameters

red	Red (0 to 255)
blue	Green (0 to 255)
green	Blue (0 to 255)

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