ReferencePlane Class
The commands in the ReferencePlane 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 of reference plane from the selected face and axis. More...

double	GetDistance ()
	Returns the distance from the selected face to the reference plane. 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...

bool	GetReverseForAngle ()
	Returns True if the direction is reversed when the reference plane is created based on the angle from the face and axis. More...

bool	GetReverseForDistance ()
	Returns True if the direction is reversed when the reference plane is created based on the angle from the face and axis. More...

bool	GetReverseForPlane1 ()
	Returns True if the plane1 direction is reversed when the reference plane is created based on from the two faces. More...

bool	GetReverseForPlane2 ()
	Returns True if the plane2 direction is reversed when the reference plane is created based on from the two faces. More...

String	GetScriptTypeName ()
	Returns the name of the object type as a string. More...

int	GetType ()
	Returns the value for how to specify a reference plane. More...

String	GetTypeAsString ()
	Returns how to specify a reference plane 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 the angle of the reference plane from the referred face and axis. More...

void	SetDistance (double value)
	Specifies the distance from the selected face to the reference plane. 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	SetReverseForAngle (bool value)
	Specifies whether to reverse the direction or not when the reference plane is created based on the angle from the face and axis. More...

void	SetReverseForDistance (bool value)
	Specifies whether to reverse the direction or not when the reference plane is created based on the distance from a face. More...

void	SetReverseForPlane1 (bool value)
	Specifies whether to reverse the plane1 direction or not when the reference plane is created based from the two faces. More...

void	SetReverseForPlane2 (bool value)
	Specifies whether to reverse the plane2 direction or not when the reference plane is created based from the two faces. More...

void	SetTargetFor2Planes (ReferenceObject plane1, ReferenceObject plane2)
	Specifies two planes to reference when the reference plane is determined by two planes. More...

void	SetTargetFor3Points (ReferenceObject p1, ReferenceObject p2, ReferenceObject *p3)
	Specifies three points to reference when the reference plane is determined by three points. More...

void	SetTargetForAngle (ReferenceObject line, ReferenceObject face)
	Specifies three points to reference when the reference plane is determined by three points. More...

void	SetTargetForDistance (ReferenceObject *face)
	Specifies the face and line to reference when the reference plane is created based on the distance from a face. More...

void	SetTargetForLineAndVertex (ReferenceObject line, ReferenceObject vertex)
	Specifies the line and point to reference when the reference plane is determined by a line and point. More...

void	SetTargetForPlaneAndVertex (ReferenceObject plane, ReferenceObject vertex)
	Specifies the plane and point to reference when the reference plane is determined by a plane and point. More...

void	SetType (int t)
	Specifies the value for how to specify a reference plane. More...

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

Detailed Description

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

The ReferencePlane class includes the commands for the following operation.

Commands related to setting a reference plane

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 ReferencePlane::GetAngle ( )

Returns the angle of reference plane from the selected face and axis.

Returns: Angle

double ReferencePlane::GetDistance ( )

Returns the distance from the selected face to the reference plane.

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

bool ReferencePlane::GetReverseForAngle ( )

Returns True if the direction is reversed when the reference plane is created based on the angle from the face and axis.

Returns: Returns True when a direction is reversed.

bool ReferencePlane::GetReverseForDistance ( )

Returns True if the direction is reversed when the reference plane is created based on the angle from the face and axis.

Returns: Returns True when a direction is reversed.

bool ReferencePlane::GetReverseForPlane1 ( )

Returns True if the plane1 direction is reversed when the reference plane is created based on from the two faces.

Returns: Returns True when a direction is reversed.

bool ReferencePlane::GetReverseForPlane2 ( )

Returns True if the plane2 direction is reversed when the reference plane is created based on from the two faces.

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

int ReferencePlane::GetType ( )

Returns the value for how to specify a reference plane.

Returns: 0 : Specifies from the line and point.

1 : Specifies three points.

2 : Specifies the distance from two faces.

3 : Specifies an angle from a face and axis.

4 : Specifies from the plane and point.

5 : Specifies two planes.

String ReferencePlane::GetTypeAsString ( )

Returns how to specify a reference plane as a string.

Returns: LineVertex : Specifies from the line and point.

3Vertex : Specifies three points.

Distance : Specifies the distance from two faces.

Angle : Specifies an angle from a face and axis.

PlaneVertex : Specifies from the plane and point.

2Plane : Specifies two planes.

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 ReferencePlane::SetAngle ( double value )

Specifies the angle of the reference plane from the referred face and axis.

Parameters

value Angle

void ReferencePlane::SetDistance ( double value )

Specifies the distance from the selected face to the reference plane.

Parameters

value Distance

void ItemObject::SetName ( String & name )

inherited

Specifies a name.

Parameters

name Item name

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 ReferencePlane::SetReverseForAngle ( bool value )

Specifies whether to reverse the direction or not when the reference plane is created based on the angle from the face and axis.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void ReferencePlane::SetReverseForDistance ( bool value )

Specifies whether to reverse the direction or not when the reference plane is created based on the distance from a face.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void ReferencePlane::SetReverseForPlane1 ( bool value )

Specifies whether to reverse the plane1 direction or not when the reference plane is created based from the two faces.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void ReferencePlane::SetReverseForPlane2 ( bool value )

Specifies whether to reverse the plane2 direction or not when the reference plane is created based from the two faces.

Parameters

value

True=on : Reverse

False=off : Do not reverse

void ReferencePlane::SetTargetFor2Planes	(	ReferenceObject *	plane1,
		ReferenceObject *	plane2
	)

Specifies two planes to reference when the reference plane is determined by two planes.

Parameters

face1	ReferenceObject object
face2	ReferenceObject object

void ReferencePlane::SetTargetFor3Points	(	ReferenceObject *	p1,
		ReferenceObject *	p2,
		ReferenceObject *	p3
	)

Specifies three points to reference when the reference plane is determined by three points.

Parameters

p1	ReferenceObject object
p2	ReferenceObject object
p3	ReferenceObject object

void ReferencePlane::SetTargetForAngle	(	ReferenceObject *	line,
		ReferenceObject *	face
	)

Specifies three points to reference when the reference plane is determined by three points.

Parameters

line	ReferenceObject object
face	ReferenceObject object

void ReferencePlane::SetTargetForDistance ( ReferenceObject * face )

Specifies the face and line to reference when the reference plane is created based on the distance from a face.

Parameters

face	ReferenceObject object

void ReferencePlane::SetTargetForLineAndVertex	(	ReferenceObject *	line,
		ReferenceObject *	vertex
	)

Specifies the line and point to reference when the reference plane is determined by a line and point.

Parameters

line	ReferenceObject object
vertex	ReferenceObject object

void ReferencePlane::SetTargetForPlaneAndVertex	(	ReferenceObject *	plane,
		ReferenceObject *	vertex
	)

Specifies the plane and point to reference when the reference plane is determined by a plane and point.

Parameters

face	ReferenceObject object
vertex	ReferenceObject object

void ReferencePlane::SetType ( int t )

Specifies the value for how to specify a reference plane.

Parameters

t	0 : Specifies from the line and point. 1 : Specifies three points. 2 : Specifies the distance from two faces. 3 : Specifies an angle from a face and axis. 4 : Specifies from the plane and point. 5 : Specifies two planes.

void ReferencePlane::SetTypeByString ( String & t )

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

Parameters

t	LineVertex : Specifies from the line and point. 3Vertex : Specifies three points. Distance : Specifies the distance from two faces. Angle : Specifies an angle from a face and axis. PlaneVertex : Specifies from the plane and point. 2Plane : Specifies two planes.

Public Member Functions

Detailed Description

Member Function Documentation