Public Member Functions | List of all members
SketchSpline Class Reference

SketchSpline Class
The commands in the SketchSpline 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...
 
SketchVertexGetControlPoint (int number)
 Returns the control point that configures the spline. 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...
 
virtual bool IsValid ()
 Returns True if an object is valid. More...
 
int NumControlPoints ()
 Returns the number of control points that configures the spline. More...
 
int NumItems ()
 Returns the number of items. 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...
 

Detailed Description

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

The SketchSpline 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)
SketchVertex * SketchSpline::GetControlPoint ( int  number)

Returns the control point that configures the spline.

Parameters
numberControl point ID (Start from 0)
Returns
SketchVertex object
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
virtual bool SketchItem::IsValid ( )
virtualinherited

Returns True if an object is valid.

Returns
Whether or not the object are valid

Reimplemented from ItemObject.

int SketchSpline::NumControlPoints ( )

Returns the number of control points that configures the spline.

Returns
Number of control point
int ItemObject::NumItems ( )
inherited

Returns the number of items.

Returns
Item count
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)