ConstraintDistance Class Reference

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

Inherits ConstraintObject.

Public Member Functions
virtual void	AddPropertyByReference (String &name, ReferenceObject *value)
	Adds ReferenceObject object to a specified variable. More...
double	GetDistance ()
	Returns the distance. 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...
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	NumItems ()
	Returns the number of items. More...
void	SetDistance (double distance)
	Specifies a distance. 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

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

The ConstraintDistance class that is under the ConstraintObject class includes commands for the following operations.

• Commands related to setting the distance in constraint.

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)

double ConstraintDistance::GetDistance

(

)

Returns the distance.

Returns

Distance

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

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

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 ItemObject::NumItems ( )

inherited

Returns the number of items.

Returns

Item count

void ConstraintDistance::SetDistance

(

double

distance

)

Specifies a distance.

Parameters

distance

Distance

void ItemObject::SetName ( String &  name )

inherited

Specifies a name.

Parameters

name

Item name

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

virtualinherited

Specifies a value of property.

Parameters

name	Property name
value	Value of properties

Reimplemented from ItemObject.

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

virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters

name	Property name
value	ReferenceObject object (target)