CIP C++ documentation for class "wfcAssemblyDistanceRule"

Class wfcAssemblyDistanceRule

# include <wfcAssembly.h> class wfcAssemblyDistanceRule : public virtual wfcAssemblyRule { xdeclare(wfcAssemblyDistanceRule) ... }; This is a COMPACT class.

Description

The rule for gathering components within specified distance from a point.

Gathers all the components within the specified spherical region.

Manual References:: Assemblies and Components: Gathering Components by Distance from a Point

Method Summary


`static wfcAssemblyDistanceRule_ptr`	`Create (pfcVector3D_ptr Center, xreal Distance, xbool IncludeDatums)`
	Create an object of AssemblyDistanceRule.

`pfcVector3D_ptr`	`GetCenter ()`
`void`	`SetCenter (pfcVector3D_ptr value)`
	Center point from which to measure the distance (in the coordinates of the top assembly).

`xreal`	`GetDistance ()`
`void`	`SetDistance (xreal value)`
	Distance value to compare against.

`xbool`	`GetIncludeDatums ()`
`void`	`SetIncludeDatums (xbool value)`
	If `true` use bounding box, if `false` use regeneration outline.

Methods Inherited from Class wfcAssemblyRule:: GetRuleType

Method Detail

`pfcVector3D_ptr`	`GetCenter`	`()`
`void`	`SetCenter`	`(pfcVector3D_ptr value)`

Center point from which to measure the distance (in the coordinates of the top assembly).

Manual References:: Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point

`xreal`	`GetDistance`	`()`
`void`	`SetDistance`	`(xreal value)`

Distance value to compare against.

Manual References:: Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point

`xbool`	`GetIncludeDatums`	`()`
`void`	`SetIncludeDatums`	`(xbool value)`

If true use bounding box, if false use regeneration outline.

Manual References:: Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point

static wfcAssemblyDistanceRule_ptr Create (pfcVector3D_ptr Center, xreal Distance, xbool IncludeDatums)

Create an object of AssemblyDistanceRule.

Manual References:: Assemblies and Components: Gathering Components by Distance from a Point, Assemblies and Components: Gathering Components by Distance from a Point

Parameters:

Center: The center point.
Distance: The distance from center point.
IncludeDatums: Specify bounding box (true) or regeneration outline (false).

Returns:: The AssemblyDistanceRule object.