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

bool	GetMerge ()
	Returns whether or not to merge with an existing geometry. 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 surface. 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 string. More...

int	GetType ()
	Returns the value for the type of extrusion as a number. More...

String	GetTypeAsString ()
	Returns the type of extrusion 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, bool merge)
	Specifies the height, whether or not to reverse the direction and whether or not to merge with an existing geometry of extrude surface. More...

void	SetHeight (double value)
	Specifies the height of a piece to extrude surface. More...

void	SetMerge (bool value)
	Specifies whether or not to merge with an existing geometry. 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)
	Specifies the specification method point on rotation axis for a skew in number. More...

void	SetSkewAxisTypeByName (String &value)
	Specifies the 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 surface as a number. More...

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

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

Detailed Description

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

The ExtrudeSurface class includes the commands for the following operation.

Commands related to set extrude surface

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 ExtrudeSurface::GetHeight ( )

Returns the height to extrude.

Returns: Height of a piece to be surfaced 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

bool ExtrudeSurface::GetMerge ( )

Returns whether or not to merge with an existing geometry.

Returns: Whether or not to merge

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 ExtrudeSurface::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 * ExtrudeSurface::GetSketch ( )

Returns the sketch used to extrude a surface.

Returns: Sketch object

double ExtrudeSurface::GetSkewAngle ( )

Returns the rotation angle of a skew.

Returns: Rotation angle of a skew

int ExtrudeSurface::GetSkewAxisType ( )

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

Returns: 1 : Selects point

0 : Specifies coordinates

String ExtrudeSurface::GetSkewAxisTypeAsString ( )

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

Returns: SelectVertex : Selects point

SetCoordinate : Specifies coordinates

int ExtrudeSurface::GetType ( )

Returns the value for the type of extrusion as a number.

Returns: True=1 : Both sides

False=0 : One side

String ExtrudeSurface::GetTypeAsString ( )

Returns the type of extrusion as a string.

Returns: BothSides : Both sides

OneSide : One side

bool ExtrudeSurface::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 ExtrudeSurface::SetData	(	double	height,
		bool	reverse,
		bool	merge
	)

Specifies the height, whether or not to reverse the direction and whether or not to merge with an existing geometry of extrude surface.

Parameters

height	Height
reverse	True=1 : reverse False=0 : Do not reverse
merge	True=on : Merge False=off : Do not merge

Deprecated:: Please use SetProperty().

void ExtrudeSurface::SetHeight ( double value )

Specifies the height of a piece to extrude surface.

Parameters

value Height of a piece to be surfaced from a part

void ExtrudeSurface::SetMerge ( bool value )

Specifies whether or not to merge with an existing geometry.

Parameters

value

True=on : Merge

False=off : Do not merge

void ItemObject::SetName ( String & name )

inherited

Specifies a name.

Parameters

name Item name

void ExtrudeSurface::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 ExtrudeSurface::SetReverse ( bool value )

Specifies whether or not to reverse the direction.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void ExtrudeSurface::SetSkewAngle ( double value )

Specifies the rotation angle of a skew.

Parameters

value Rotation angle of a skew

void ExtrudeSurface::SetSkewAxisType ( int value )

Specifies the specification method point on rotation axis for a skew in number.

Parameters

value

1 : Selects point

0 : Specifies coordinates

void ExtrudeSurface::SetSkewAxisTypeByName ( String & value )

Specifies the specification method of point on rotation axis for a skew in string.

Parameters

value

SelectVertex = Selects point

SetCoordinate = Specifies coordinates

void ExtrudeSurface::SetType ( int value )

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

Parameters

value

True=1 : Both sides

False=0 : One side

void ExtrudeSurface::SetTypeByName ( String & value )

Specifies the type of extrusion surface using a string.

Returns: Bothsides

Oneside

void ExtrudeSurface::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