ReferenceLine Class
The commands in the ReferenceLine 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...

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...

ReferenceObject *	GetLine ()
	Returns the line. 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...

int	GetType ()
	Returns a value as the method for specifying a reference line. More...

String	GetTypeAsString ()
	Returns a string as the method for specifying a reference line. More...

double	GetXOffset ()
	Returns the offset value from the reference line in the X coordinate. More...

double	GetYOffset ()
	Returns the offset value from the reference line in the Y coordinate. More...

double	GetZOffset ()
	Returns the offset value from the reference line in the Z coordinate. More...

virtual bool	IsValid ()
	Returns True if an object is valid. More...

int	NumItems ()
	Returns the number of items. More...

void	SetCircle (ReferenceObject *ref)
	Specifies the cylindrical face or circle to reference. More...

void	SetLine (ReferenceObject *ref)
	Specifies the line to reference. More...

void	SetLineAndVertexList (StringList &value)
	Specifies the line and point. More...

void	SetLineList (StringList &value)
	Specifies two lines. More...

void	SetName (String &name)
	Specifies a name. More...

void	SetOffset (double x, double y, double z)
	Specifies the offset value from the reference line in each coordinate. More...

void	SetPlaneAndVertexList (StringList &value)
	Specifies the plane and point. More...

void	SetPlaneList (StringList &value)
	Specifies two planes. 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	SetType (int t)
	Specifies a value as the method for specifying a reference line. More...

void	SetTypeByString (String &t)
	Determines how to specify a reference line by using a string. More...

void	SetVertexList (StringList &value)
	Specifies two points. More...

void	SetXOffset (double value)
	Specifies the offset value from the reference line in the X coordinate. More...

void	SetYOffset (double value)
	Specifies the offset value from the reference line in the Y coordinate. More...

void	SetZOffset (double value)
	Specifies the offset value from the reference line in the Z coordinate. More...

Detailed Description

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

The ReferenceLine class includes the commands for the following operation.

Commands related setting a reference line

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)

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

ReferenceObject * ReferenceLine::GetLine ( )

Returns the line.

Returns: ReferenceObject 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

int ReferenceLine::GetType ( )

Returns a value as the method for specifying a reference line.

Returns: 0 : Specifies an offset from a line

1 : Specifies two points

2 : Specifies two planes

3 : Specifies two lines

4 : Specifies the plane and point

5 : Specifies the line and point

6 : Specifies the cylindrical face or circle

String ReferenceLine::GetTypeAsString ( )

Returns a string as the method for specifying a reference line.

Returns: LineOffset : Specifies an offset from a line

2Points : Specifies two points

2Planes : Specifies two planes

2Lines : Specifies two lines

PlaneVertex : Specifies the plane and point

LineVertex : Specifies the line and point

Circle : Specifies the cylindrical face or circle

double ReferenceLine::GetXOffset ( )

Returns the offset value from the reference line in the X coordinate.

Returns: Offset value in the X coordinate

double ReferenceLine::GetYOffset ( )

Returns the offset value from the reference line in the Y coordinate.

Returns: Offset value in the Y coordinate

double ReferenceLine::GetZOffset ( )

Returns the offset value from the reference line in the Z coordinate.

Returns: Offset value in the Z coordinate

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 ReferenceLine::SetCircle ( ReferenceObject * ref )

Specifies the cylindrical face or circle to reference.

Parameters

ref	ReferenceObject object

void ReferenceLine::SetLine ( ReferenceObject * ref )

Specifies the line to reference.

Parameters

ref	ReferenceObject object

void ReferenceLine::SetLineAndVertexList ( StringList & value )

Specifies the line and point.

Parameters

value List of IDs of the line and point

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

void ReferenceLine::SetLineList ( StringList & value )

Specifies two lines.

Parameters

value List of IDs of two lines

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

void ItemObject::SetName ( String & name )

inherited

Specifies a name.

Parameters

name Item name

void ReferenceLine::SetOffset	(	double	x,
		double	y,
		double	z
	)

Specifies the offset value from the reference line in each coordinate.

Parameters

x	Offset value in the X coordinate
y	Offset value in the Y coordinate
z	Offset value in the Z coordinate

void ReferenceLine::SetPlaneAndVertexList ( StringList & value )

Specifies the plane and point.

Parameters

value List of IDs of the plane and point

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

void ReferenceLine::SetPlaneList ( StringList & value )

Specifies two planes.

Parameters

value List of IDs of two planes

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

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

virtualinherited

Specifies a value of property.

Parameters

name	Property name
value	Value of properties

Reimplemented in SketchItem.

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

virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters

name	Property name
value	ReferenceObject object (target)

void ReferenceLine::SetType ( int t )

Specifies a value as the method for specifying a reference line.

Parameters

t	0 : Specifies an offset from a line 1 : Specifies two points 2 : Specifies two planes 3 : Specifies two lines 4 : Specifies the plane and point 5 : Specifies the line and point 6 : Specifies the cylindrical face or circle

void ReferenceLine::SetTypeByString ( String & t )

Determines how to specify a reference line by using a string.

Parameters

t	LineOffset : Specifies an offset from a line 2Points : Specifies two points 2Planes : Specifies two planes 2Lines : Specifies two lines PlaneVertex : Specifies the plane and point LineVertex : Specifies the line and point Circle : Specifies the cylindrical face or circle

void ReferenceLine::SetVertexList ( StringList & value )

Specifies two points.

Parameters

value List of IDs of two points

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

void ReferenceLine::SetXOffset ( double value )

Specifies the offset value from the reference line in the X coordinate.

Parameters

value Offset value in the X coordinate

void ReferenceLine::SetYOffset ( double value )

Specifies the offset value from the reference line in the Y coordinate.

Parameters

value Offset value in the Y coordina

void ReferenceLine::SetZOffset ( double value )

Specifies the offset value from the reference line in the Z coordinate.

Parameters

value Offset value in the Z coordinate

Public Member Functions

Detailed Description

Member Function Documentation