NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder Class Reference

Represents a NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder builder
To create a new instance of this class, use NXOpen::Features::Subdivision::SubdivisionBodyCollection::CreateSubdivisionProjectCageBuilder
Default values. More...

Inheritance diagram for NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ModeOptions { ModeOptionsLinear, ModeOptionsPlanar }
 Best fit mode. More...
 
enum  TargetTypes {
  TargetTypesInferredPlane, TargetTypesInferredAxis, TargetTypesYcZcPlane, TargetTypesXcZcPlane,
  TargetTypesXcYcPlane, TargetTypesXcAxis, TargetTypesYcAxis, TargetTypesZcAxis,
  TargetTypesObject, TargetTypesPlane, TargetTypesDynamicPlane
}
 Target types. More...
 
enum  Types { TypesToTarget, TypesToAverage, TypesAlignNormal }
 The type of projection. More...
 

Public Member Functions

NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::ModeOptions Mode ()
 Returns the mode
Created in NX9.0.0. More...
 
NXOpen::Features::Subdivision::SelectCageObjectDataObjectsToProject ()
 Returns the objects to project
Created in NX9.0.0. More...
 
void OnTargetDynamicPlane ()
 Update builder data based on target dynamic plane definition
Created in NX10.0.0. More...
 
void OnTargetPlane ()
 Update builder data based on target plane definition
Created in NX9.0.1. More...
 
void SetMode (NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::ModeOptions mode)
 Sets the mode
Created in NX9.0.0. More...
 
void SetTargetDynamicPlane (NXOpen::CoordinateSystem *csys)
 Sets the target dynamic plane
Created in NX10.0.0. More...
 
void SetTargetPlane (NXOpen::Plane *plane)
 Sets the target plane
Created in NX9.0.1. More...
 
void SetTargetType (NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetTypes targetType)
 Sets the target type
Created in NX9.0.0. More...
 
void SetType (NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::Types type)
 Sets the type
Created in NX9.0.0. More...
 
NXOpen::SelectDisplayableObjectTarget ()
 Returns the target
Created in NX9.0.0. More...
 
NXOpen::Features::Subdivision::SelectCageObjectDataTargetCageObjects ()
 Returns the target cage objects to infer a plane or axis from
Created in NX9.0.0. More...
 
NXOpen::CoordinateSystemTargetDynamicPlane ()
 Returns the target dynamic plane
Created in NX10.0.0. More...
 
NXOpen::PlaneTargetPlane ()
 Returns the target plane
Created in NX9.0.1. More...
 
NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetTypes TargetType ()
 Returns the target type
Created in NX9.0.0. More...
 
NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::Types Type ()
 Returns the type
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder builder
To create a new instance of this class, use NXOpen::Features::Subdivision::SubdivisionBodyCollection::CreateSubdivisionProjectCageBuilder
Default values.

Property Value

Mode

Planar

TargetType

InferredPlane


Created in NX9.0.0.

Member Enumeration Documentation

Best fit mode.

Enumerator
ModeOptionsLinear 

Fit a line.

ModeOptionsPlanar 

Fit a plane.

Target types.

Enumerator
TargetTypesInferredPlane 

inferred plane

TargetTypesInferredAxis 

inferred axis

TargetTypesYcZcPlane 

yc zc plane

TargetTypesXcZcPlane 

xc zc plane

TargetTypesXcYcPlane 

xc yc plane

TargetTypesXcAxis 

xc axis

TargetTypesYcAxis 

yc axis

TargetTypesZcAxis 

zc axis

TargetTypesObject 

object

TargetTypesPlane 

plane

TargetTypesDynamicPlane 

dynamic plane

The type of projection.

Enumerator
TypesToTarget 

Project on target.

TypesToAverage 

Project using best fit plane or axis.

TypesAlignNormal 

Align edges normal to the specified plane.

Member Function Documentation

NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::ModeOptions NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::Mode ( )

Returns the mode
Created in NX9.0.0.



License requirements : None

NXOpen::Features::Subdivision::SelectCageObjectData* NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::ObjectsToProject ( )

Returns the objects to project
Created in NX9.0.0.



License requirements : None

void NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::OnTargetDynamicPlane ( )

Update builder data based on target dynamic plane definition
Created in NX10.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

void NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::OnTargetPlane ( )

Update builder data based on target plane definition
Created in NX9.0.1.



License requirements : nx_subdivision (" NX SUBDIVISION")

void NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::SetMode ( NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::ModeOptions  mode)

Sets the mode
Created in NX9.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
modemode
void NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::SetTargetDynamicPlane ( NXOpen::CoordinateSystem csys)

Sets the target dynamic plane
Created in NX10.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
csyscsys
void NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::SetTargetPlane ( NXOpen::Plane plane)

Sets the target plane
Created in NX9.0.1.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
planeplane
void NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::SetTargetType ( NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetTypes  targetType)

Sets the target type
Created in NX9.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
targetTypetargettype
void NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::SetType ( NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::Types  type)

Sets the type
Created in NX9.0.0.



License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters
typetype
NXOpen::SelectDisplayableObject* NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::Target ( )

Returns the target
Created in NX9.0.0.



License requirements : None

NXOpen::Features::Subdivision::SelectCageObjectData* NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetCageObjects ( )

Returns the target cage objects to infer a plane or axis from
Created in NX9.0.0.



License requirements : None

NXOpen::CoordinateSystem* NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetDynamicPlane ( )

Returns the target dynamic plane
Created in NX10.0.0.



License requirements : None

NXOpen::Plane* NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetPlane ( )

Returns the target plane
Created in NX9.0.1.



License requirements : None

NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetTypes NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::TargetType ( )

Returns the target type
Created in NX9.0.0.



License requirements : None

NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::Types NXOpen::Features::Subdivision::SubdivisionProjectCageBuilder::Type ( )

Returns the type
Created in NX9.0.0.



License requirements : None


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