M

SpatialFieldManager.AddSpatialFieldPrimitive

Description:
Creates an empty analysis results primitive associated with a reference, with the option to control how the reference element is hidden.

Remarks:

There can be multiple primitives associated with one reference, normally they would be shown with different results. However this is justified only if they have different sets of domain points. Otherwise one primitive can be used to display values for different results.

Overloads (5):

AddSpatialFieldPrimitive

AddSpatialFieldPrimitive(Curve,Transform)

AddSpatialFieldPrimitive(Face,Transform)

AddSpatialFieldPrimitive(Reference)

AddSpatialFieldPrimitive(Reference,SpatialFieldPrimitiveHideMode)

public int AddSpatialFieldPrimitive(
	Reference reference,
	SpatialFieldPrimitiveHideMode hidingMode
)

Public Function AddSpatialFieldPrimitive ( 
	reference As Reference,
	hidingMode As SpatialFieldPrimitiveHideMode
) As Integer

public:
int AddSpatialFieldPrimitive(
	Reference^ reference, 
	SpatialFieldPrimitiveHideMode hidingMode
)

member AddSpatialFieldPrimitive : 
        reference : Reference * 
        hidingMode : SpatialFieldPrimitiveHideMode -> int

Reference

reference

Reference pointing to the curve or face to be associated with the primitive
SpatialFieldPrimitiveHideMode

hidingMode

The mode used to hide the original model element

Return Value Int32 Unique index of primitive for future references

ArgumentException

reference points to neither face nor curve
ArgumentNullException

A non-optional argument was null
ArgumentOutOfRangeException

A value passed for an enumeration argument is not a member of that enumeration