RegionLinearPattern Class
The commands in the RegionLinearPattern 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	GetAngle1 ()
	Returns the angle in the direction 1. More...

double	GetAngle2 ()
	Returns the angle in the direction 2. More...

ReferenceObject *	GetAxis ()
	Returns the line or reference line that determines the reference direction. More...

int	GetInstance1 ()
	Returns the number of regions to be created in the direction 1. More...

int	GetInstance2 ()
	Returns the number of regions to be created in the direction 2. 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	GetReverse1 ()
	Returns True when the direction1 is reversed. More...

bool	GetReverse2 ()
	Returns True when the direction2 is reversed. More...

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

double	GetSpacing1 ()
	Returns the interval between regions to be created in the direction 1. More...

double	GetSpacing2 ()
	Returns the interval between regions to be created in the direction 2. More...

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

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

void	SetAngle1 (double value)
	Specifies the angle in the direction 1. More...

void	SetAngle2 (double value)
	Specifies the angle in the direction 2. More...

void	SetAxis (ReferenceObject *axis)
	Specifies the line or reference line that determines the deference direction. More...

void	SetInstance1 (int value)
	Specifies the number of regions to be created in the direction 1. More...

void	SetInstance2 (int value)
	Specifies the number of regions to be created in the direction 2. 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 &value)
	Specifies the list of region IDs to copy. More...

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

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

void	SetSpacing1 (double value)
	Specifies the interval between regions to be created in direction 1. More...

void	SetSpacing2 (double value)
	Specifies the interval between regions to be created in direction 2. More...

Detailed Description

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

The RegionLinearPattern class includes the commands for the following operation.

Commands related to setting region linear pattern

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 RegionLinearPattern::GetAngle1 ( )

Returns the angle in the direction 1.

Returns: Angle

double RegionLinearPattern::GetAngle2 ( )

Returns the angle in the direction 2.

Returns: Angle

ReferenceObject * RegionLinearPattern::GetAxis ( )

Returns the line or reference line that determines the reference direction.

Returns: ReferenceObject object

int RegionLinearPattern::GetInstance1 ( )

Returns the number of regions to be created in the direction 1.

Returns: Creates in the direction 1

int RegionLinearPattern::GetInstance2 ( )

Returns the number of regions to be created in the direction 2.

Returns: Creates in the direction 2

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 RegionLinearPattern::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 RegionLinearPattern::GetRegionList ( )

Returns a list of region IDs to copy.

Returns: List of region IDs

bool RegionLinearPattern::GetReverse1 ( )

Returns True when the direction1 is reversed.

Returns: Whether or not the direction 1 is reversed

bool RegionLinearPattern::GetReverse2 ( )

Returns True when the direction2 is reversed.

Returns: Whether or not the direction 2 is reversed

String ItemObject::GetScriptTypeName ( )

inherited

Returns the name of the object type as a string.

Returns: Type name of object

double RegionLinearPattern::GetSpacing1 ( )

Returns the interval between regions to be created in the direction 1.

Returns: Interval in direction 1

double RegionLinearPattern::GetSpacing2 ( )

Returns the interval between regions to be created in the direction 2.

Returns: Interval in direction 2

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 RegionLinearPattern::SetAngle1 ( double value )

Specifies the angle in the direction 1.

Parameters

value Angle

void RegionLinearPattern::SetAngle2 ( double value )

Specifies the angle in the direction 2.

Parameters

value Angle

void RegionLinearPattern::SetAxis ( ReferenceObject * axis )

Specifies the line or reference line that determines the deference direction.

Parameters

axis	ReferenceObject object

void RegionLinearPattern::SetInstance1 ( int value )

Specifies the number of regions to be created in the direction 1.

Parameters

value Creates in the direction 1.

void RegionLinearPattern::SetInstance2 ( int value )

Specifies the number of regions to be created in the direction 2.

Parameters

value Creates in the direction 2.

void RegionLinearPattern::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 RegionLinearPattern::SetRegionList ( StringList & value )

Specifies the list of region IDs to copy.

Parameters

value List of region IDs

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

void RegionLinearPattern::SetReverse1 ( bool value )

Specifies whether or not to reverse direction 1.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void RegionLinearPattern::SetReverse2 ( bool value )

Specifies whether or not to reverse direction 2.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void RegionLinearPattern::SetSpacing1 ( double value )

Specifies the interval between regions to be created in direction 1.

Parameters

value Pattern interval in direction 1

void RegionLinearPattern::SetSpacing2 ( double value )

Specifies the interval between regions to be created in direction 2.

Parameters

value Pattern interval in direction 2

Public Member Functions

Detailed Description

Member Function Documentation