Public Member Functions | List of all members
RegionMirrorCopy Class Reference

RegionMirrorCopy Class
The commands in the RegionMirrorCopy 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...
 
ItemObjectGetItem (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...
 
String GetScriptTypeName ()
 Returns the name of the object type as a string. More...
 
ReferenceObjectGetSymmetry ()
 Returns the mirror plane. More...
 
virtual bool IsValid ()
 Returns True if an object is valid. More...
 
int NumItems ()
 Returns the number of items. 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 &regions)
 Specifies the list of region IDs to copy. More...
 
void SetSymmetry (ReferenceObject *center)
 Specifies the mirror plane. More...
 

Detailed Description

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

The RegionMirrorCopy class includes the commands for the following operation.

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
nameProperty name
valueReferenceObject object (target)
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
valueItem name or index
Returns
ItemObject object
bool RegionMirrorCopy::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
nameProperty name
Returns
Value of properties
StringList RegionMirrorCopy::GetRegionList ( )

Returns a list of region IDs to copy.

Returns
List of region IDs
String ItemObject::GetScriptTypeName ( )
inherited

Returns the name of the object type as a string.

Returns
Type name of object
ReferenceObject * RegionMirrorCopy::GetSymmetry ( )

Returns the mirror plane.

Returns
ReferenceObject 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 RegionMirrorCopy::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
nameItem name
void ItemObject::SetProperty ( String &  name,
Variant &  value 
)
virtualinherited

Specifies a value of property.

Parameters
nameProperty name
valueValue of properties

Reimplemented in SketchItem.

void ItemObject::SetPropertyByReference ( String &  name,
ReferenceObject value 
)
virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters
nameProperty name
valueReferenceObject object (target)
void RegionMirrorCopy::SetRegionList ( StringList &  regions)

Specifies the list of region IDs to copy.

Parameters
regionsList of region IDs

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

void RegionMirrorCopy::SetSymmetry ( ReferenceObject center)

Specifies the mirror plane.

Parameters
centerReferenceObject object