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

int	GetDivisions ()
	Returns number of divisions. 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...

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

bool	GetReverse ()
	Returns True as a value when a direction is reversed. 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...

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

double	GetSkewAngle ()

int	GetSkewAxisType ()

String	GetSkewAxisTypeAsString ()

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

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

bool	GetUseSkew ()

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. More...

void	SetDivisions (int value)
	Specifies number of divisions. More...

void	SetHeight (double value)
	Specifies the height to extrude. 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)

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 extrusion direction. More...

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

void	SetSkewAngle (double value)

void	SetSkewAxisType (int value)

void	SetSkewAxisTypeByName (String &value)

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

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

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

Detailed Description

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

The ExtrudeSolid class includes the commands for the following operation.

Commands related to set 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)

int ExtrudeSolid::GetDivisions ( )

Returns number of divisions.

Returns: Divisions

double ExtrudeSolid::GetHeight ( )

Returns the height to extrude.

Returns: Height of a piece 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 ExtrudeSolid::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 ExtrudeSolid::GetRatio ( )

Returns division ratio.

Returns: Division ratio

bool ExtrudeSolid::GetReverse ( )

Returns True as a value when a direction is reversed.

Returns: Returns True when a direction is reversed.

bool ExtrudeSolid::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

Sketch * ExtrudeSolid::GetSketch ( )

Returns the sketch used to extrude a solid.

Returns: Sketch object

double ExtrudeSolid::GetSkewAngle ( )

Deprecated:

Returns the rotation angle of a skew.

Returns: Rotation angle of a skew

Corresponds to the following function of JMAG-Designer11.1 or later versions.

GetProperty("SkewAngle")

int ExtrudeSolid::GetSkewAxisType ( )

Deprecated:

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

Returns: 0 = Selects point

1 = Specifies coordinates

String ExtrudeSolid::GetSkewAxisTypeAsString ( )

Deprecated:

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

Returns: SelectVertex = Selects point

SetCoordinate = Specifies coordinates

int ExtrudeSolid::GetType ( )

Returns the type of extrusion as a number.

Returns: True=1 : Both sides

False=0 : One side

String ExtrudeSolid::GetTypeAsString ( )

Returns the type of extrusion as a string.

Returns: BothSides : Both sides

OneSide : One side

bool ExtrudeSolid::GetUseSkew ( )

Deprecated:

Returns True when skew is set.

Returns: Whether or not the skew is set

Corresponds to the following function of JMAG-Designer11.1 or later versions.

GetProperty("UseSkew")

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 ExtrudeSolid::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.

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 ExtrudeSolid::SetDivisions ( int value )

Specifies number of divisions.

Parameters

value Divisions

void ExtrudeSolid::SetHeight ( double value )

Specifies the height to extrude.

Parameters

value Height of a piece from a part

void ExtrudeSolid::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 ExtrudeSolid::SetPointOnSkewAxis	(	double	x,
		double	y,
		double	z
	)

Deprecated:

Specifies a point on rotation axis for skew shape 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

Corresponds to the following function of JMAG-Designer11.1 or later versions. 
SetProperty("XOnSkewAxis", double x) 
SetProperty("YOnSkewAxis", double y) 
SetProperty("ZOnSkewAxis", double z) 

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

Specifies division ratio.

Parameters

ratio Division ratio

void ExtrudeSolid::SetReverse ( bool value )

Specifies whether or not to reverse extrusion direction.

Parameters

value

True=on : Reverse

False=off : Do not reverse

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

void ExtrudeSolid::SetSkewAngle ( double value )

Deprecated:

Specifies the rotation angle of a skew.

Parameters

value Rotation angle of a skew

Corresponds to the following function of JMAG-Designer11.1 or later versions.

SetProperty("SkewAngle", double value)

void ExtrudeSolid::SetSkewAxisType ( int value )

Deprecated:

Determines the specification method of the point on rotation axis for skew shape in number.

Parameters

value

0 = Selects point

1 = Specifies coordinates

void ExtrudeSolid::SetSkewAxisTypeByName ( String & value )

Deprecated:

Determines the specification method of the point on rotation axis for skew shape in string.

Parameters

value

SelectVertex = Selects point

SetCoordinate = Specifies coordinates

void ExtrudeSolid::SetType ( int value )

Specifies the type of extrusion as a number.

Parameters

value

True=1 : Both sides

False=0 : One side

void ExtrudeSolid::SetTypeByName ( String & value )

Specifies the type of extrusion as a string.

Parameters

value

BothSides

OneSide

void ExtrudeSolid::SetUseSkew ( bool value )

Specifies whether or not to set the skew.

Parameters

value

0/True=on : Skew

1/False=off : Do not skew

Corresponds to the following function of JMAG-Designer11.1 or later versions.
SetProperty("UseSkew", bool value)

Public Member Functions

Detailed Description

Member Function Documentation