Represents a SnipFacetBody builder
To create a new instance of this class, use NXOpen::Facet::FacetedBodyCollection::CreateSnipFacetBodyBuilder
Default values. More...

Inheritance diagram for NXOpen::Facet::SnipFacetBodyBuilder:

Public Types
enum	BoundaryFacetTreatmentMethod { BoundaryFacetTreatmentMethodSnipFacets, BoundaryFacetTreatmentMethodRemoveFacets }
	Boundary facet treatment type: More...

enum	DirectionType { DirectionTypeViewDirection, DirectionTypeFacetNormal, DirectionTypeAlongVector }
	Snipping direction when snipping type "by profiles". More...

enum	Types { TypesSnipByBoundary, TypesSnipByRegion, TypesSnipWithCurves, TypesSnipAtPlane }
	Snip method. More...

Public Member Functions
NXOpen::Facet::SnipFacetBodyBuilder::DirectionType	AlongDirection ()
	Returns the direction in which snipping profiles are projected on the facet bodies Created in NX7.5.0. More...

NXOpen::SelectDisplayableObjectList *	Bodies ()
	Returns the facet bodies to snip. More...

NXOpen::Facet::SnipFacetBodyBuilder::BoundaryFacetTreatmentMethod	BoundaryFacetTreatmentType ()
	Returns the boundary facet treatment type Created in NX7.5.0. More...

bool	CanDivide ()
	Returns the value indicating if facet body is to be divided Created in NX7.5.0. More...

NXOpen::Facet::SelectFacetedBodyList *	FacetBodies ()
	Returns the facet bodies to snip More...

NXOpen::FacetCollector *	FacetCollector ()
	Returns the collector of facets to be snipped. More...

bool	IsEditCopy ()
	Returns the value indicating if a copy of the facet body to be snipped without altering the original Created in NX7.5.0. More...

bool	IsSnipNearFacets ()
	Returns the value indicating if only facets near to the viewer to be snipped Created in NX7.5.0. More...

NXOpen::Plane *	Plane ()
	Returns the snipping plane Created in NX7.5.0. More...

NXOpen::SectionList *	ProfileList ()
	Returns the list of snipping profiles Created in NX7.5.0. More...

NXOpen::Direction *	ProjectionVector ()
	Returns the projection vector Created in NX7.5.0. More...

NXOpen::GeometricUtilities::BoundaryDefinitionBuilderList *	RegionList ()
	Returns the list of regions to snip Created in NX7.5.0. More...

NXOpen::SelectPointList *	RegionPoint ()
	Returns the point indicating the portion of the facet body with respect to specified region to be snipped. More...

void	SetAlongDirection (NXOpen::Facet::SnipFacetBodyBuilder::DirectionType alongDirection)
	Sets the direction in which snipping profiles are projected on the facet bodies Created in NX7.5.0. More...

void	SetBoundaryFacetTreatmentType (NXOpen::Facet::SnipFacetBodyBuilder::BoundaryFacetTreatmentMethod boundaryFacetTreatmentType)
	Sets the boundary facet treatment type Created in NX7.5.0. More...

void	SetCanDivide (bool canDivide)
	Sets the value indicating if facet body is to be divided Created in NX7.5.0. More...

void	SetEditCopy (bool isEditCopy)
	Sets the value indicating if a copy of the facet body to be snipped without altering the original Created in NX7.5.0. More...

void	SetFacetCollector (NXOpen::FacetCollector *collector)
	Sets the collector of facets to be snipped. More...

void	SetPlane (NXOpen::Plane *plane)
	Sets the snipping plane Created in NX7.5.0. More...

void	SetProjectionVector (NXOpen::Direction *projectionVector)
	Sets the projection vector Created in NX7.5.0. More...

void	SetSnipNearFacets (bool isSnipNearFacets)
	Sets the value indicating if only facets near to the viewer to be snipped Created in NX7.5.0. More...

void	SetType (NXOpen::Facet::SnipFacetBodyBuilder::Types type)
	Sets the snipping method accessor Created in NX7.5.0. More...

void	SetViewDirection (const NXOpen::Vector3d &viewDirection)
	Sets the view direction Created in NX7.5.0. More...

void	SwitchRegion ()
	Switch the region to be snipped indicated by the region point. More...

NXOpen::Facet::SnipFacetBodyBuilder::Types	Type ()
	Returns the snipping method accessor Created in NX7.5.0. More...

NXOpen::Vector3d	ViewDirection ()
	Returns the view direction Created in NX7.5.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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 SnipFacetBody builder
To create a new instance of this class, use NXOpen::Facet::FacetedBodyCollection::CreateSnipFacetBodyBuilder
Default values.

Property

Value

AlongDirection

ViewDirection

BoundaryFacetTreatmentType

SnipFacets

CanDivide

0

IsEditCopy

0

IsSnipNearFacets

0

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Facet::SnipFacetBodyBuilder::BoundaryFacetTreatmentMethod

Boundary facet treatment type:

Enumerator
BoundaryFacetTreatmentMethodSnipFacets	Snip scarred facets by the border.
BoundaryFacetTreatmentMethodRemoveFacets	Remove scarred facets.

enum NXOpen::Facet::SnipFacetBodyBuilder::DirectionType

Snipping direction when snipping type "by profiles".

Enumerator
DirectionTypeViewDirection	Snip along view direction.
DirectionTypeFacetNormal	Snip along facet normal.
DirectionTypeAlongVector	Snip along specified vector.

enum NXOpen::Facet::SnipFacetBodyBuilder::Types

Snip method.

Enumerator
TypesSnipByBoundary	Snip by boundary.
TypesSnipByRegion	Snip by region.
TypesSnipWithCurves	Snip with curves.
TypesSnipAtPlane	Snip at plane.

Member Function Documentation

NXOpen::Facet::SnipFacetBodyBuilder::DirectionType NXOpen::Facet::SnipFacetBodyBuilder::AlongDirection ( )

Returns the direction in which snipping profiles are projected on the facet bodies
Created in NX7.5.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Facet::SnipFacetBodyBuilder::Bodies ( )

Returns the facet bodies to snip.

Inputs to this command can be convergent objects.
Created in NX11.0.0.

License requirements : None

NXOpen::Facet::SnipFacetBodyBuilder::BoundaryFacetTreatmentMethod NXOpen::Facet::SnipFacetBodyBuilder::BoundaryFacetTreatmentType ( )

Returns the boundary facet treatment type
Created in NX7.5.0.

License requirements : None

bool NXOpen::Facet::SnipFacetBodyBuilder::CanDivide ( )

Returns the value indicating if facet body is to be divided
Created in NX7.5.0.

License requirements : None

NXOpen::Facet::SelectFacetedBodyList* NXOpen::Facet::SnipFacetBodyBuilder::FacetBodies ( )

Returns the facet bodies to snip

Deprecated:: Deprecated in NX11.0.0.

Use NXOpen::Facet::SnipFacetBodyBuilder::Bodies instead.

Created in NX7.5.0.

License requirements : None

NXOpen::FacetCollector* NXOpen::Facet::SnipFacetBodyBuilder::FacetCollector ( )

Returns the collector of facets to be snipped.

Created in NX12.0.0.

License requirements : None

bool NXOpen::Facet::SnipFacetBodyBuilder::IsEditCopy ( )

Returns the value indicating if a copy of the facet body to be snipped without altering the original
Created in NX7.5.0.

License requirements : None

bool NXOpen::Facet::SnipFacetBodyBuilder::IsSnipNearFacets ( )

Returns the value indicating if only facets near to the viewer to be snipped
Created in NX7.5.0.

License requirements : None

NXOpen::Plane* NXOpen::Facet::SnipFacetBodyBuilder::Plane ( )

Returns the snipping plane
Created in NX7.5.0.

License requirements : None

NXOpen::SectionList* NXOpen::Facet::SnipFacetBodyBuilder::ProfileList ( )

Returns the list of snipping profiles
Created in NX7.5.0.

License requirements : None

NXOpen::Direction* NXOpen::Facet::SnipFacetBodyBuilder::ProjectionVector ( )

Returns the projection vector
Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::BoundaryDefinitionBuilderList* NXOpen::Facet::SnipFacetBodyBuilder::RegionList ( )

Returns the list of regions to snip
Created in NX7.5.0.

License requirements : None

NXOpen::SelectPointList* NXOpen::Facet::SnipFacetBodyBuilder::RegionPoint ( )

Returns the point indicating the portion of the facet body with respect to specified region to be snipped.

Created in NX7.5.0.

License requirements : None

void NXOpen::Facet::SnipFacetBodyBuilder::SetAlongDirection ( NXOpen::Facet::SnipFacetBodyBuilder::DirectionType alongDirection )

Sets the direction in which snipping profiles are projected on the facet bodies
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

alongDirection alongdirection

void NXOpen::Facet::SnipFacetBodyBuilder::SetBoundaryFacetTreatmentType ( NXOpen::Facet::SnipFacetBodyBuilder::BoundaryFacetTreatmentMethod boundaryFacetTreatmentType )

Sets the boundary facet treatment type
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

boundaryFacetTreatmentType boundaryfacettreatmenttype

void NXOpen::Facet::SnipFacetBodyBuilder::SetCanDivide ( bool canDivide )

Sets the value indicating if facet body is to be divided
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

canDivide candivide

void NXOpen::Facet::SnipFacetBodyBuilder::SetEditCopy ( bool isEditCopy )

Sets the value indicating if a copy of the facet body to be snipped without altering the original
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

isEditCopy iseditcopy

void NXOpen::Facet::SnipFacetBodyBuilder::SetFacetCollector ( NXOpen::FacetCollector * collector )

Sets the collector of facets to be snipped.

Created in NX12.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

collector collector

void NXOpen::Facet::SnipFacetBodyBuilder::SetPlane ( NXOpen::Plane * plane )

Sets the snipping plane
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

plane plane

void NXOpen::Facet::SnipFacetBodyBuilder::SetProjectionVector ( NXOpen::Direction * projectionVector )

Sets the projection vector
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

projectionVector projectionvector

void NXOpen::Facet::SnipFacetBodyBuilder::SetSnipNearFacets ( bool isSnipNearFacets )

Sets the value indicating if only facets near to the viewer to be snipped
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

isSnipNearFacets issnipnearfacets

void NXOpen::Facet::SnipFacetBodyBuilder::SetType ( NXOpen::Facet::SnipFacetBodyBuilder::Types type )

Sets the snipping method accessor
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

type type

void NXOpen::Facet::SnipFacetBodyBuilder::SetViewDirection ( const NXOpen::Vector3d & viewDirection )

Sets the view direction
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

viewDirection viewdirection

void NXOpen::Facet::SnipFacetBodyBuilder::SwitchRegion ( )

Switch the region to be snipped indicated by the region point.

Created in NX7.5.0.

License requirements : None

NXOpen::Facet::SnipFacetBodyBuilder::Types NXOpen::Facet::SnipFacetBodyBuilder::Type ( )

Returns the snipping method accessor
Created in NX7.5.0.

License requirements : None

NXOpen::Vector3d NXOpen::Facet::SnipFacetBodyBuilder::ViewDirection ( )

Returns the view direction
Created in NX7.5.0.

License requirements : None

The documentation for this class was generated from the following file:

Facet_SnipFacetBodyBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation