SolidCircularPattern Class
The commands in the SolidCircularPattern 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	GetAngle ()
	Returns a rotation angle. More...

ReferenceObject *	GetAxis ()
	Returns a rotation axis. More...

int	GetInstance ()
	Returns the total number of solids to be created. 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 the solids. 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...

StringList	GetTargetList ()
	Returns a list of solid IDs to copy. More...

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

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

void	SetAngle (double value)
	Specifies a rotation angle. More...

void	SetAxis (ReferenceObject *value)
	Selects a rotation axis. More...

void	SetInstance (int value)
	Specifies the total number of solids to create. More...

void	SetMerge (bool value)
	Specifies whether or not to merge the solids. 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	SetTargetList (StringList &value)
	Specifies a list of solid IDs to copy. More...

Detailed Description

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

SolidCircularPattern Object.

The SolidCircularPattern class includes the commands for the following operation.

Commands related to setting a solid circular pattern

For more information about the properties for this class, see here .

Attention

no use property list

Solid ReferenceObjectList solid
Axis ReferenceObject axis
Instance Integer instance
Reverse Bool reverse direction
Angle Real angle
Merge Bool merge

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 SolidCircularPattern::GetAngle ( )

Returns a rotation angle.

Returns: Rotation angle

ReferenceObject * SolidCircularPattern::GetAxis ( )

Returns a rotation axis.

Returns: ReferenceObject object

int SolidCircularPattern::GetInstance ( )

Returns the total number of solids to be created.

Returns: Total number of solids to be created.

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 SolidCircularPattern::GetMerge ( )

Returns whether or not to merge the solids.

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

StringList SolidCircularPattern::GetTargetList ( )

Returns a list of solid IDs to copy.

Returns: List of solid IDs

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 SolidCircularPattern::SetAngle ( double value )

Specifies a rotation angle.

Parameters

value Rotation angle

void SolidCircularPattern::SetAxis ( ReferenceObject * value )

Selects a rotation axis.

Parameters

value ReferenceObject object

void SolidCircularPattern::SetInstance ( int value )

Specifies the total number of solids to create.

Parameters

value Total number of solids to be created

void SolidCircularPattern::SetMerge ( bool value )

Specifies whether or not to merge the solids.

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

Specifies whether or not to reverse the direction.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void SolidCircularPattern::SetTargetList ( StringList & value )

Specifies a list of solid IDs to copy.

Parameters

value List of solid IDs

For more information about the commands of string array type, see "Example of the String Array Type."

Public Member Functions

Detailed Description

Member Function Documentation