Share

EmbossFeatures.AddEmbossFromFace Method

Parent Object: EmbossFeatures

Description

Method that creates a new emboss feature by embossing a profile on one or more faces in the model.

Remarks

If the emboss feature is created successfully, an EmbossFeature object corresponding to the newly created emboss feature is returned from this method.

Syntax

EmbossFeatures.AddEmbossFromFace( Profile As Profile, Distance As Variant, ExtentDirection As PartFeatureExtentDirectionEnum, [TopFaceColor] As Variant, [WrapFace] As Variant ) As EmbossFeature

Parameters

Name Type Description
Profile Profile Input Profile object used to define the shape of the emboss. The specified profile must be closed, otherwise (i.e. if the profile is open), the creation of the emboss feature will fail. The closed profiles can constitute both sketch entities as well as text.

Distance Variant Input Variant that defines the depth of the emboss. This can be either a numeric value or a string. A parameter for this value will be created and the supplied string or value is assigned to the parameter. If a value is input, the units are centimeters. If a string is input, the units can be specified as part of the string or it will default to the current length units of the document.

ExtentDirection PartFeatureExtentDirectionEnum Input constant that indicates on which side of the sketch plane the emboss feature should be created. First, the profile will be projected along the specified direction onto all faces that are in that direction. Then, the emboss feature will be generated by embossing the projected profile on these faces. Valid input is either kPositiveExtentDirection or kNegativeExtentDirection constant value in PartFeatureExtentDirectionEnum. The value kPositiveExtentDirection defines the projection direction of the profile to be in the same direction as the normal of the sketch plane that contains the profile to be embossed. If kSymmetricExtentDirection is specified, then the creation of the emboss feature will fail.

TopFaceColor Variant Optional Input Variant that defines the render style to use for the top face of the emboss feature. The valid input is a RenderStyle object. If no input is specified, then the default render style will be applied.



This is an optional argument whose default value is null.

WrapFace Variant Optional Input Variant that specifies the face around which the emboss feature should be wrapped. The valid input is a Face object. This argument can be used to specify a curved face around which the emboss feature should be wrapped. The face can only be planar or conical, not a spline. If the emboss profile is large relative to the amount of curvature, the embossed or engraved area distorts slightly as it projects to the curved face. The wrap stops when a perpendicular face is encountered. If this argument is not specified, then it implies that the emboss feature should not be wrapped around any face, but created as a result of straight projection onto the face.

This is an optional argument whose default value is null.

Version

Introduced in version 2008

Was this information helpful?