Public Member Functions | List of all members
SketchVertex Class Reference

SketchVertex Class
The commands in the SketchVertex class are described below.
. More...

Inherits SketchItem.

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...
 
String GetName ()
 Returns a name. More...
 
virtual Variant GetProperty (String &name)
 Returns the value of the property with the specified name. More...
 
String GetScriptTypeName ()
 Returns the name of the object type as a string. More...
 
double GetX ()
 Returns the point in the X coordinate. More...
 
double GetY ()
 Returns the point in the Y coordinate. More...
 
virtual bool IsValid ()
 Returns True if an object is valid. More...
 
int NumItems ()
 Returns the number of items. More...
 
void SetData (double x, double y)
 Specifies the point in the coordinate. More...
 
void SetName (String &name)
 Specifies a name. More...
 
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 SetX (double value)
 Specifies the X coordinate. More...
 
void SetY (double value)
 Specifies the Y coordinate. More...
 

Detailed Description

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

The SketchVertex 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
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
String ItemObject::GetScriptTypeName ( )
inherited

Returns the name of the object type as a string.

Returns
Type name of object
double SketchVertex::GetX ( )

Returns the point in the X coordinate.

Returns
Vertex on the X coordinate
double SketchVertex::GetY ( )

Returns the point in the Y coordinate.

Returns
Vertex on the Y coordinate
virtual bool SketchItem::IsValid ( )
virtualinherited

Returns True if an object is valid.

Returns
Whether or not the object are valid

Reimplemented from ItemObject.

int ItemObject::NumItems ( )
inherited

Returns the number of items.

Returns
Item count
void SketchVertex::SetData ( double  x,
double  y 
)

Specifies the point in the coordinate.

Parameters
xVertex on the X coordinate
yVertex on the Y coordinate
Deprecated:
Please use SetProperty().
void ItemObject::SetName ( String &  name)
inherited

Specifies a name.

Parameters
nameItem name
void SketchItem::SetProperty ( String &  name,
Variant &  value 
)
virtualinherited

Specifies a value of property.

Parameters
nameProperty name
valueValue of properties

Reimplemented from ItemObject.

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

Specifies the values in properties by ReferenceObject object.

Parameters
nameProperty name
valueReferenceObject object (target)
void SketchVertex::SetX ( double  value)

Specifies the X coordinate.

Parameters
valueVertex on the X coordinate
void SketchVertex::SetY ( double  value)

Specifies the Y coordinate.

Parameters
valueVertex on the Y coordinate