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

ReferenceObject *	GetDirection ()
	Returns direction of face extrude. More...

int	GetDivisions ()
	Returns number of divisions. More...

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

double	GetRatio ()
	Returns division ratio. More...

bool	GetReverse ()
	Returns True when the face extrude direction is reverse. More...

bool	GetReverseRatio ()
	Returns True when the direction of the division ratio applied is reverse. More...

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

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

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

void	SetData (ReferenceObject *direction, 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 face extrude. More...

void	SetDirection (ReferenceObject *direction)
	Specifies number of divisions. More...

void	SetDivisions (int value)
	Specifies number of divisions. 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...

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	SetRatio (double ratio)
	Specifies division ratio. More...

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

void	SetReverseRatio (bool value)
	Specifies whether or not to reverse direction of the division ratio applied. More...

Detailed Description

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

The FaceExtrudeSolid class includes the commands for the following operation.

Parameter settings for face extrude

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)

ReferenceObject * FaceExtrudeSolid::GetDirection ( )

Returns direction of face extrude.

Returns: ReferenceObject object

int FaceExtrudeSolid::GetDivisions ( )

Returns number of divisions.

Returns: Divisions

double FaceExtrudeSolid::GetHeight ( )

Returns the height of face extrude.

Returns: Height of extrude

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 FaceExtrudeSolid::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

double FaceExtrudeSolid::GetRatio ( )

Returns division ratio.

Returns: Division ratio

bool FaceExtrudeSolid::GetReverse ( )

Returns True when the face extrude direction is reverse.

Returns: Whether or not a direction is reverse

bool FaceExtrudeSolid::GetReverseRatio ( )

Returns True when the direction of the division ratio applied is reverse.

Returns: Whether or not a direction is reverse

String ItemObject::GetScriptTypeName ( )

inherited

Returns the name of the object type as a string.

Returns: Type name of object

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 FaceExtrudeSolid::SetData	(	ReferenceObject *	direction,
		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 face extrude.

Parameters

direction	Direction
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 FaceExtrudeSolid::SetDirection ( ReferenceObject * direction )

Specifies number of divisions.

Parameters

direction ReferenceObject object

void FaceExtrudeSolid::SetDivisions ( int value )

Specifies number of divisions.

Parameters

value Division ratio

void FaceExtrudeSolid::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 FaceExtrudeSolid::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 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 FaceExtrudeSolid::SetRatio ( double ratio )

Specifies division ratio.

Parameters

ratio Division ratio

void FaceExtrudeSolid::SetReverse ( bool value )

Specifies whether or not to reverse direction.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void FaceExtrudeSolid::SetReverseRatio ( bool value )

Specifies whether or not to reverse direction of the division ratio applied.

Parameters

value

True=on : Reverse

False=off : Do not reverse

Public Member Functions

Detailed Description

Member Function Documentation