RegionCircularPattern Class
The commands in the RegionCircularPattern 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 the angle. More...

ReferenceObject *	GetCenter ()
	Returns the center of the rotation. More...

int	GetInstance ()
	Returns the total number of regions. 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 regions. More...

String	GetName ()
	Returns a name. More...

virtual Variant	GetProperty (String &name)
	Returns the value of the property with the specified name. More...

StringList	GetRegionList ()
	Returns a list of region IDs to copy. 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...

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

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

void	SetAngle (double value)
	Specifies an angle. More...

void	SetCenter (ReferenceObject *center)
	Specifies the center of rotation. More...

void	SetInstance (int value)
	Specifies the total number of regions. More...

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

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

Detailed Description

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

RegionCircularPattern Object.

The RegionCircularPattern class includes the commands for the following operation.

Commands related to setting region circular pattern

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

Attention

use property list

Angle Real angle of pattern
Instance Integer instance of pattern
Reverse Bool reverse direction
Merge Bool merge
Center ReferenceObject center of circular pattern
Region ReferenceObjectList region

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

Returns the angle.

Returns: Angle

ReferenceObject * RegionCircularPattern::GetCenter ( )

Returns the center of the rotation.

Returns: ReferenceObject object

int RegionCircularPattern::GetInstance ( )

Returns the total number of regions.

Returns: Total number of regions 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 RegionCircularPattern::GetMerge ( )

Returns whether or not to merge the regions.

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

StringList RegionCircularPattern::GetRegionList ( )

Returns a list of region IDs to copy.

Returns: List of region IDs

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

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

Specifies an angle.

Parameters

value Angle

void RegionCircularPattern::SetCenter ( ReferenceObject * center )

Specifies the center of rotation.

Parameters

center ReferenceObject object

void RegionCircularPattern::SetInstance ( int value )

Specifies the total number of regions.

Parameters

value Total number of regions created.

void RegionCircularPattern::SetMerge ( bool value )

Specifies whether or not to merge the regions.

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 RegionCircularPattern::SetRegionList ( StringList & region )

Specifies the list of region IDs to copy.

Parameters

region List of region IDs

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

void RegionCircularPattern::SetReverse ( bool value )

Specifies whether or not to reverse the direction.

Parameters

value

True=on : Reverse

False=off : Do not reverse

Public Member Functions

Detailed Description

Member Function Documentation