NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::EmbossRegion Class Reference

Represents an emboss region object. More...

Inheritance diagram for NXOpen::Features::EmbossRegion:
NXOpen::TaggedObject

List of all members.

Public Types

enum  ConvexityOption { ConvexityOptionAbove, ConvexityOptionBelow, ConvexityOptionMixed }
 Describes whether the emboss geometry is above the target("Pad") or below the target("Pocket"), or both("Mixed"). More...

Public Member Functions

NXOpen::Features::EmbossRegion::ConvexityOption Convexity ()
 Returns the convexity option
Created in NX4.0.0.
NXOpen::DirectionDirection ()
 Returns the default direction
Created in NX4.0.0.
std::vector
< NXOpen::Features::EmbossLimit * > 
GetLimits ()
 The emboss limits.
NXOpen::Features::EmbossProjectionProjection ()
 Returns the emboss projection object
Created in NX4.0.0.
NXOpen::SectionSection ()
 Returns the section that is composed of chains
Created in NX4.0.0.
void SetConvexity (NXOpen::Features::EmbossRegion::ConvexityOption convexity)
 Sets the convexity option
Created in NX4.0.0.
void SetDirection (NXOpen::Direction *direction)
 Sets the default direction
Created in NX4.0.0.
void SetLimits (const std::vector< NXOpen::Features::EmbossLimit * > &limits)
 The emboss limits
Created in NX4.0.0.
void SetProjection (NXOpen::Features::EmbossProjection *projection)
 Sets the emboss projection object
Created in NX4.0.0.
void SetSection (NXOpen::Section *section)
 Sets the section that is composed of chains
Created in NX4.0.0.
void SetSidewall (NXOpen::Features::EmbossSidewall *sidewall)
 Sets the emboss sidewall object
Created in NX4.0.0.
NXOpen::Features::EmbossSidewallSidewall ()
 Returns the emboss sidewall object
Created in NX4.0.0.

Detailed Description

Represents an emboss region object.


This class provides methods to set and get the various emboss region sub components.

Following are default values and options:


Section User must set it

Direction If user do not specify it, it uses section normal as default direction.

Convexity Option Features::EmbossRegion::ConvexityOptionMixed

Emboss Projection EmbossProjection object

Emboss Sidewall EmbossSidewall object

Emboss Limit (array) EmbossLimit object


Created in NX4.0.0.


Member Enumeration Documentation

Describes whether the emboss geometry is above the target("Pad") or below the target("Pocket"), or both("Mixed").

Enumerator:
ConvexityOptionAbove 

Indicates the emboss geometry is above the target("Pad").

ConvexityOptionBelow 

Indicates the emboss geometry is below the target("Pocket").

ConvexityOptionMixed 

Indicates the emboss geometry is both above and below the Target("Mixed").

Default creation.


Member Function Documentation

Returns the convexity option
Created in NX4.0.0.



License requirements : None

Returns the default direction
Created in NX4.0.0.



License requirements : None

The emboss limits.

Returns:
Array of EmbossLimit objects. In NX4, only one limit is supported.
Created in NX4.0.0.

License requirements : None

Returns the emboss projection object
Created in NX4.0.0.



License requirements : None

Returns the section that is composed of chains
Created in NX4.0.0.



License requirements : None

Sets the convexity option
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
convexityThe convexity option. See the comment of Features::EmbossRegion::ConvexityOption for more details.

Sets the default direction
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
directionThe default direction for section projection/translation/sidewall/joggle, if they are not specified

The emboss limits
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
limitsArray of EmbossLimit objects. In NX4, only one limit is supported.

Sets the emboss projection object
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
projectionThe emboss projection object

Sets the section that is composed of chains
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
sectionThe section that is composed of chains. Each Chain will be a tangent list of curves so the Draft angles for sidewalls can be managed properly.

Sets the emboss sidewall object
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
sidewallThe emboss sidewall object

Returns the emboss sidewall object
Created in NX4.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.