ExtrudeImprint Class
The commands in the ExtrudeImprint 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 imprint. 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 a sketch used to extrude imprint. More...

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

String	GetTypeAsString ()
	Returns the value for the type of extrude imprint 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 (double height, bool reverse)
	Specifies the height and whether or not to reverse the direction of extrude imprint. More...

void	SetHeight (double value)
	Specifies the height of extrude imprint. 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	SetReverse (bool value)
	Specifies whether or not to reverse the direction. More...

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

void	SetTypeByName (String &value)
	Specifies the value for the type of extrude imprint as a string. More...

Detailed Description

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

The ExtrudeImprint class includes the commands for the following operation.

Commands related to set extrude imprint

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

Returns the height to extrude imprint.

Returns: Height of a piece to be imprinted 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 ExtrudeImprint::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 * ExtrudeImprint::GetSketch ( )

Returns a sketch used to extrude imprint.

Returns: Sketch object

int ExtrudeImprint::GetType ( )

Returns the value for the type of extrude imprint as a number.

Returns: True=1 : Both sides

False=0 : One side

String ExtrudeImprint::GetTypeAsString ( )

Returns the value for the type of extrude imprint as a string.

Returns: BothSides : Both sides

OneSide : One side

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

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

Parameters

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

Deprecated:: Please use SetProperty().

void ExtrudeImprint::SetHeight ( double value )

Specifies the height of extrude imprint.

Parameters

value Height of a piece to be imprinted from a part

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

Specifies whether or not to reverse the direction.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void ExtrudeImprint::SetType ( int value )

Specifies the value for the type of extrude imprint as a number.

Parameters

value

True=1 : Both sides

False=0 : One side

void ExtrudeImprint::SetTypeByName ( String & value )

Specifies the value for the type of extrude imprint as a string.

Parameters

value

BothSides : Both sides

OneSide : One side

Public Member Functions

Detailed Description

Member Function Documentation