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

double	GetHeight ()
	Returns the height to extrude. 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...

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

bool	GetReverse ()
	Returns True as a value when a direction is reversed. More...

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

Sketch *	GetSketch ()
	Returns the sketch used to extrude a solid. More...

double	GetSkewAngle ()
	Returns the rotation angle of a skew. More...

int	GetSkewAxisType ()
	Returns a specification method of point on rotation axis for a skew in integer. More...

String	GetSkewAxisTypeAsString ()
	Returns a specification method of point on rotation axis for a skew in integer. More...

int	GetType ()
	Returns the value for the type of extrusion cut. More...

String	GetTypeAsString ()
	Returns the type of extrusion cut as a string. More...

bool	GetUseSkew ()
	Returns True when skew is set. More...

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

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

void	SetData (double height, bool reverse)
	Specifies the height and whether or not to reverse the direction of extrude cut. More...

void	SetHeight (double value)
	Specifies the height of a piece to cut from a solid. More...

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

void	SetPointOnSkewAxis (double x, double y, double z)
	Specifies a point on rotation axis of a skew in coordinates. 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...

void	SetReverse (bool value)
	Specifies whether or not to reverse the direction. More...

void	SetSkewAngle (double value)
	Specifies the rotation angle of a skew. More...

void	SetSkewAxisType (int value)
	Specification method of point on rotation axis for a skew in number. More...

void	SetSkewAxisTypeByName (String &value)
	Specification method of point on rotation axis for a skew in string. More...

void	SetType (int value)
	Specifies the value for the type of extrusion cut as a number. More...

void	SetTypeByName (String &value)
	Specifies the type of extrusion cut using a string. More...

void	SetUseSkew (bool value)
	Specifies whether or not to set the skew. More...

Detailed Description

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

The ExtrudeCut class includes the commands for the following operation.

Commands related to set a piece to be extruded from 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)

double ExtrudeCut::GetHeight ( )

Returns the height to extrude.

Returns: Height of a piece to be extruded from a part

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

Variant ItemObject::GetProperty ( String & name )

virtualinherited

Returns the value of the property with the specified name.

Parameters

name	Property name

Returns: Value of properties

bool ExtrudeCut::GetReverse ( )

Returns True as a value when a direction is reversed.

Returns: Returns True when a direction is reversed

String ItemObject::GetScriptTypeName ( )

inherited

Returns the name of the object type as a string.

Returns: Type name of object

Sketch * ExtrudeCut::GetSketch ( )

Returns the sketch used to extrude a solid.

Returns: Sketch object

double ExtrudeCut::GetSkewAngle ( )

Returns the rotation angle of a skew.

Returns: Rotation angle of a skew

int ExtrudeCut::GetSkewAxisType ( )

Returns a specification method of point on rotation axis for a skew in integer.

Returns: 0 : Selects point

1 : Specifies coordinates

String ExtrudeCut::GetSkewAxisTypeAsString ( )

Returns a specification method of point on rotation axis for a skew in integer.

Returns: SelectVertex : Selects point

SetCoordinate : Specifies coordinates

int ExtrudeCut::GetType ( )

Returns the value for the type of extrusion cut.

Returns: True=1 : Both sides

False=0 : One side

String ExtrudeCut::GetTypeAsString ( )

Returns the type of extrusion cut as a string.

Returns: BothSides : Both sides

OneSide : One side

bool ExtrudeCut::GetUseSkew ( )

Returns True when skew is set.

Returns: Whether or not the skew is set

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.

int ItemObject::NumItems ( )

inherited

Returns the number of items.

Returns: Item count

void ExtrudeCut::SetData	(	double	height,
		bool	reverse
	)

Specifies the height and whether or not to reverse the direction of extrude cut.

Parameters

height	Height
reverse	True=1 : reverse False=0 : Do not reverse

Deprecated:: Please use SetProperty().

void ExtrudeCut::SetHeight ( double value )

Specifies the height of a piece to cut from a solid.

Parameters

value Height of a piece to be extruded from a part

void ItemObject::SetName ( String & name )

inherited

Specifies a name.

Parameters

name Item name

void ExtrudeCut::SetPointOnSkewAxis	(	double	x,
		double	y,
		double	z
	)

Specifies a point on rotation axis of a skew in coordinates.

Parameters

x	X-coordinate for point on rotation axis of skew
y	Y-coordinate for point on rotation axis of skew
z	Z-coordinate for point on rotation axis of skew

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)

void ExtrudeCut::SetReverse ( bool value )

Specifies whether or not to reverse the direction.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void ExtrudeCut::SetSkewAngle ( double value )

Specifies the rotation angle of a skew.

Parameters

value Rotation angle of a skew

void ExtrudeCut::SetSkewAxisType ( int value )

Specification method of point on rotation axis for a skew in number.

Parameters

value

0 : Selects point

1 : Specifies coordinates

void ExtrudeCut::SetSkewAxisTypeByName ( String & value )

Specification method of point on rotation axis for a skew in string.

Parameters

value

SelectVertex : Selects point

SetCoordinate : Specifies coordinates

void ExtrudeCut::SetType ( int value )

Specifies the value for the type of extrusion cut as a number.

Parameters

value

True=on : Both sides

False=off : One side

void ExtrudeCut::SetTypeByName ( String & value )

Specifies the type of extrusion cut using a string.

Parameters

value

BothSides

OneSide

void ExtrudeCut::SetUseSkew ( bool value )

Specifies whether or not to set the skew.

Parameters

value

0/True=on : Skew

1/False=off : Do not skew

Public Member Functions

Detailed Description

Member Function Documentation