Public Member Functions | List of all members
RegionChamfer Class Reference

RegionChamfer Class
The commands in the RegionChamfer 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...
 
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...
 
double GetLength ()
 Returns the length. 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 chamfer. 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 SetLength (double value)
 Specifies the length. 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 chamfer. More...
 
void SetReverse (bool value)
 Specifies whether or not to reverse the direction. More...
 

Detailed Description

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

The RegionChamfer 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)
double RegionChamfer::GetAngle ( )

Returns the angle.

Returns
Angle
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
double RegionChamfer::GetLength ( )

Returns the length.

Returns
Length
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 RegionChamfer::GetRegionList ( )

Returns a list of region IDs to chamfer.

Returns
List of region IDs
bool RegionChamfer::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 RegionChamfer::SetAngle ( double  value)

Specifies an angle.

Parameters
valueAngle
void RegionChamfer::SetLength ( double  value)

Specifies the length.

Parameters
valueLength
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 RegionChamfer::SetRegionList ( StringList &  value)

Specifies the list of region IDs to chamfer.

Parameters
valueList of region IDs

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

void RegionChamfer::SetReverse ( bool  value)

Specifies whether or not to reverse the direction.

Parameters
value
True=on : Reverse
False=off : Do not reverse