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

ReferenceObject *	GetDirection1 ()
	Returns the direction 1. More...

ReferenceObject *	GetDirection2 ()
	Returns the direction 2. More...

int	GetInstance1 ()
	Returns total number of solids to be created in direction 1. More...

int	GetInstance2 ()
	Returns total number of solids to be created in 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 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	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 solids to be created in the direction 1. More...

double	GetSpacing2 ()
	Returns the interval between solids to be created in the direction 2. 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	SetDirection1 (ReferenceObject *value)
	Specifies Direction 1. More...

void	SetDirection2 (ReferenceObject *value)
	Specifies Direction 2. More...

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

void	SetInstance2 (int value)
	Specifies the number of solids to be created in the direction 2. 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	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 solids to be created in the direction 1. More...

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

void	SetTargetList (StringList &value)
	Specifies a list of solid IDs to copy. More...

Detailed Description

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

The SolidLinearPattern class includes the commands for the following operation.

Commands related to setting solid linear patterns

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)

ReferenceObject * SolidLinearPattern::GetDirection1 ( )

Returns the direction 1.

Returns: ReferenceObject object

ReferenceObject * SolidLinearPattern::GetDirection2 ( )

Returns the direction 2.

Returns: ReferenceObject object

int SolidLinearPattern::GetInstance1 ( )

Returns total number of solids to be created in direction 1.

Returns: Total number of solids to be created in direction 1

int SolidLinearPattern::GetInstance2 ( )

Returns total number of solids to be created in direction 2.

Returns: Total number of solids to be created in 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 SolidLinearPattern::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 SolidLinearPattern::GetReverse1 ( )

Returns True when the direction1 is reversed.

Returns: Whether or not the direction 1 is reversed

bool SolidLinearPattern::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 SolidLinearPattern::GetSpacing1 ( )

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

Returns: Interval in direction 1

double SolidLinearPattern::GetSpacing2 ( )

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

Returns: Interval in direction 2

StringList SolidLinearPattern::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 SolidLinearPattern::SetDirection1 ( ReferenceObject * value )

Specifies Direction 1.

Parameters

value ReferenceObject object

void SolidLinearPattern::SetDirection2 ( ReferenceObject * value )

Specifies Direction 2.

Parameters

value ReferenceObject object

void SolidLinearPattern::SetInstance1 ( int value )

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

Parameters

value Total number of solids to be created in direction 1

void SolidLinearPattern::SetInstance2 ( int value )

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

Parameters

value Total number of solids to be created in direction 2

void SolidLinearPattern::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 SolidLinearPattern::SetReverse1 ( bool value )

Specifies whether or not to reverse direction 1.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void SolidLinearPattern::SetReverse2 ( bool value )

Specifies whether or not to reverse direction 2.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void SolidLinearPattern::SetSpacing1 ( double value )

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

Parameters

value Pattern interval in direction 1

void SolidLinearPattern::SetSpacing2 ( double value )

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

Parameters

value Pattern interval in direction 2

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