Interface IFeatures

Gives access to feature entities.

Namespace: TopSolid.Cad.Design.Automating

Assembly: TopSolid.Cad.Design.Automating.dll

Syntax

[ServiceContract]
[AvailableSinceVersion(7, 14, 0, 0)]
public interface IFeatures

Remarks

This interface is available since v7.14.

Methods

GetDrillingCounterSinkingPrimitive(ElementId, Int32, out Real, out Real, out Real, out Boolean, out Real)

Get a drilling counter sinking primitive information.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
void GetDrillingCounterSinkingPrimitive(ElementId inFeatureId, int inIndex, out Real angle, out Real coneLength, out Real diameter, out bool isOpposed, out Real position)

Parameters

Type	Name	Description
ElementId	inFeatureId	Identifiers of the element of the primitive to analyse.
Int32	inIndex	Idex of the primitive to analyse.
Real	angle	Angle of the counter sinking primitive.
Real	coneLength	Cone length of the counter sinking primitive.
Real	diameter	Diameter of the counter sinking primitive.
Boolean	isOpposed	Tells wether the counter sinking primitive is opposed.
Real	position	Position of the counter sinking primitive.

Remarks

This method is available since v7.14.

GetDrillingHolePrimitive(ElementId, Int32, out DrillingHolePrimitiveBottomType, out Real, out Real, out Real, out Boolean, out Boolean, out Boolean, out Real)

Get a drilling hole primitive information.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
void GetDrillingHolePrimitive(ElementId inFeatureId, int inIndex, out DrillingHolePrimitiveBottomType bottomType, out Real bottomAngle, out Real depth, out Real diameter, out bool isTapered, out bool isThrough, out bool isToleranced, out Real taperAngle)

Parameters

Type	Name	Description
ElementId	inFeatureId	Identifiers of the element of the primitive to analyse.
Int32	inIndex	Idex of the primitive to analyse.
DrillingHolePrimitiveBottomType	bottomType	Type of the drilling primitive, or None if the primitive is not a drilling hole primitive.
Real	bottomAngle	Bottom angle of the hole primitive.
Real	depth	Detph of the hole primitive.
Real	diameter	Diameter of the hole primitive.
Boolean	isTapered	Tells wether the hole primitive is tapered.
Boolean	isThrough	Tells wether the hole primitive is through.
Boolean	isToleranced	Tells wether the hole primitive is toleranced.
Real	taperAngle	Taper angle of the hole primitive.

Remarks

This method is available since v7.14.

GetDrillingPrimitiveCount(ElementId)

Gets the number of primitives of a drilling feature entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
int GetDrillingPrimitiveCount(ElementId inFeatureId)

Parameters

Type	Name	Description
ElementId	inFeatureId	Identifier of the feature to analyze.

Returns

Type	Description
Int32	Count of drilling primitives found.

Remarks

This method is available since v7.14.

GetDrillingPrimitiveType(ElementId, Int32)

Gets the type of a drilling feature entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
DrillingPrimitiveType GetDrillingPrimitiveType(ElementId inFeatureId, int inIndex)

Parameters

Type	Name	Description
ElementId	inFeatureId	Identifier of the element of the primitive to analyse.
Int32	inIndex	Idex of the primitive to analyse.

Returns

Type	Description
DrillingPrimitiveType	Type of the drilling feature, or None if the primitive is not a drilling primitive.

Remarks

This method is available since v7.14.

GetDrillingSpotFacingPrimitive(ElementId, Int32, out Real, out Real, out Boolean, out Real)

Get a drilling spot facing primitive information.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
void GetDrillingSpotFacingPrimitive(ElementId inFeatureId, int inIndex, out Real depth, out Real diameter, out bool isOpposed, out Real position)

Parameters

Type	Name	Description
ElementId	inFeatureId	Identifiers of the element of the primitive to analyse.
Int32	inIndex	Idex of the primitive to analyse.
Real	depth	Detph of the spot facing primitive.
Real	diameter	Diameter of the spot facing primitive.
Boolean	isOpposed	Tells wether the spot facing primitive is opposed.
Real	position	Position of the spot facing primitive.

Remarks

This method is available since v7.14.

GetDrillingTappedHolePrimitive(ElementId, Int32, out DrillingHolePrimitiveBottomType, out Real, out Real, out Real, out Real, out Real, out Boolean, out Boolean, out Boolean, out Real, out Real, out Real, out DrillingTappedHolePrimitiveThreadType)

Get a drilling tapped hole primitive information.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
void GetDrillingTappedHolePrimitive(ElementId inFeatureId, int inIndex, out DrillingHolePrimitiveBottomType bottomType, out Real bottomAngle, out Real depth, out Real gaugeLength, out Real holeDepth, out Real holeDiameter, out bool isLeftHand, out bool isTaperedThread, out bool isThrough, out Real nominalDiameter, out Real pitch, out Real taperAngle, out DrillingTappedHolePrimitiveThreadType threadType)

Parameters

Type	Name	Description
ElementId	inFeatureId	Identifiers of the element of the primitive to analyse.
Int32	inIndex	Idex of the primitive to analyse.
DrillingHolePrimitiveBottomType	bottomType	Type of the drilling primitive, or None if the primitive is not a drilling hole primitive.
Real	bottomAngle	Bottom angle of the tapped hole primitive.
Real	depth	Detph of the tapped hole primitive.
Real	gaugeLength	Gauge length of the tapped hole primitive.
Real	holeDepth	Hole depth of the tapped hole primitive.
Real	holeDiameter	Hole diameter of the tapped hole primitive.
Boolean	isLeftHand	Tells wether the tapped hole primitive is left hand.
Boolean	isTaperedThread	Tells wether the tapped hole primitive is tapered thread.
Boolean	isThrough	Tells wether the tapped hole primitive is through.
Real	nominalDiameter	Nominal diameter of the tapped hole primitive.
Real	pitch	Pitch of the tapped hole primitive.
Real	taperAngle	Taper angle of the tapped hole primitive.
DrillingTappedHolePrimitiveThreadType	threadType	Type of the thread, or None if the primitive is not a drilling tapped hole primitive.

Remarks

This method is available since v7.14.

GetFeatures(DocumentId)

Gets the features entities that are in the features folder of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
List<ElementId> GetFeatures(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
List<ElementId>	Features entities found.

Remarks

This method is available since v7.14.

GetFeaturesFolder(DocumentId)

Gets the features folder entity of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
ElementId GetFeaturesFolder(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
ElementId	Identifier of the features folder entity found.

Remarks

This method is available since v7.14.

GetFeatureType(ElementId)

Gets the type of a feature entity.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
FeatureType GetFeatureType(ElementId inElementId)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of the element to analyze.

Returns

Type	Description
FeatureType	Type of the feature, or None if the element is not a feature entity.

Remarks

This method is available since v7.14.

IsFeaturesCreationOn(DocumentId)

Tells wether the feature creation mode is on.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
bool IsFeaturesCreationOn(DocumentId inDocumentId)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to analyze.

Returns

Type	Description
Boolean	The document handle features.

Remarks

This method is available since v7.14.

SetFeaturesCreationMode(DocumentId, Boolean)

Sets the features creation mode of a document.

Declaration

[OperationContract]
[AvailableSinceVersion(7, 14, 0, 0)]
void SetFeaturesCreationMode(DocumentId inDocumentId, bool isOn)

Parameters

Type	Name	Description
DocumentId	inDocumentId	Identifier of the document to set the feature creation mode.
Boolean	isOn	Tells wether the feature creation mode is on.

Remarks

This method is available since v7.14.