Represents a NXOpen::Features::Subdivision::TransformCageData builder. More...

Inheritance diagram for NXOpen::Features::Subdivision::TransformCageData:

Public Types
enum	FallOffMethodType { FallOffMethodTypeNone, FallOffMethodTypeSelected, FallOffMethodTypeAll }
	Falloff method types. More...

enum	MovementMethodType { MovementMethodTypeWCS, MovementMethodTypeView, MovementMethodTypeVector, MovementMethodTypePlane, MovementMethodTypeNormal, MovementMethodTypeEdge }
	Movement types. More...

enum	ScalingMethodType { ScalingMethodTypeLinear, ScalingMethodTypePlanar, ScalingMethodTypeUniform }
	Scaling method. More...

enum	TransformationMethodType { TransformationMethodTypeDrag, TransformationMethodTypeTransform }
	Transformation method types. More...

enum	WCSOptionType { WCSOptionTypeInferredAxis, WCSOptionTypeX, WCSOptionTypeY, WCSOptionTypeZ, WCSOptionTypeYZ, WCSOptionTypeXZ, WCSOptionTypeXY }
	WCS principal axis or plane types. More...

Public Member Functions
NXOpen::Features::Subdivision::CageManipulatorData *	CageManipulator ()
	Returns the cage manipulation data. More...

bool	CanMoveToolOnly ()
	Returns the flag indicating if transformer tool can be moved without transforming the selected cage topology. More...

bool	CanRelocateToolToSelection ()
	Returns the flag indicating if transformer tool can be relocated based on cage topology selection. More...

bool	CanReorientToolToSelection ()
	Returns the flag indicating if transformer tool can be reoriented based on cage topology selection. More...

double	FallOffFactor ()
	Returns the falloff factor. More...

NXOpen::Features::Subdivision::TransformCageData::FallOffMethodType	FallOffMethod ()
	Returns the falloff method. More...

NXOpen::Features::Subdivision::SelectCageObjectData *	FallOffObjects ()
	Returns the falloff objects. More...

NXOpen::Features::Subdivision::TransformCageData::MovementMethodType	MovementMethod ()
	Returns the movement method. More...

NXOpen::Plane *	MovementPlane ()
	Returns the movement plane. More...

NXOpen::Direction *	MovementVector ()
	Returns the movement vector. More...

void	ResetFallOffToLinear ()
	Resets the falloff scale to linear. More...

NXOpen::Features::Subdivision::TransformCageData::ScalingMethodType	ScalingMethod ()
	Returns the scaling method. More...

void	SetCanMoveToolOnly (bool canMove)
	Sets the flag indicating if transformer tool can be moved without transforming the selected cage topology. More...

void	SetCanRelocateToolToSelection (bool canRelocate)
	Sets the flag indicating if transformer tool can be relocated based on cage topology selection. More...

void	SetCanReorientToolToSelection (bool canReorient)
	Sets the flag indicating if transformer tool can be reoriented based on cage topology selection. More...

void	SetFallOffFactor (double factor)
	Sets the falloff factor. More...

void	SetFallOffMethod (NXOpen::Features::Subdivision::TransformCageData::FallOffMethodType fallOffMethod)
	Sets the falloff method. More...

void	SetMovementMethod (NXOpen::Features::Subdivision::TransformCageData::MovementMethodType movementMethod)
	Sets the movement method. More...

void	SetMovementPlane (NXOpen::Plane *movementPlane)
	Sets the movement plane. More...

void	SetMovementVector (NXOpen::Direction *movementVector)
	Sets the movement vector. More...

void	SetScalingMethod (NXOpen::Features::Subdivision::TransformCageData::ScalingMethodType scalingMethod)
	Sets the scaling method. More...

void	SetTransformationMethod (NXOpen::Features::Subdivision::TransformCageData::TransformationMethodType method)
	Sets the transformation method. More...

void	SetWCSOption (NXOpen::Features::Subdivision::TransformCageData::WCSOptionType wcsOption)
	Sets the WCS option. More...

NXOpen::Features::Subdivision::TransformCageData::TransformationMethodType	TransformationMethod ()
	Returns the transformation method. More...

NXOpen::Features::Subdivision::TransformCageData::WCSOptionType	WCSOption ()
	Returns the WCS option. 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 NXOpen::Features::Subdivision::TransformCageData builder.

To create a new instance of this class, use NXOpen::Features::Subdivision::SubdivisionBodyCollection::CreateTransformCageData
Default values.

Property

Value

CanRelocateToolToSelection

true

CanReorientToolToSelection

true

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Features::Subdivision::TransformCageData::FallOffMethodType

Falloff method types.

Enumerator
FallOffMethodTypeNone	No falloff.
FallOffMethodTypeSelected	Selected vertices falloff.
FallOffMethodTypeAll	All vertices falloff.

enum NXOpen::Features::Subdivision::TransformCageData::MovementMethodType

Movement types.

Enumerator
MovementMethodTypeWCS	Movement along WCS principal axis or plane.
MovementMethodTypeView	Movement in view plane.
MovementMethodTypeVector	Movement along arbitrary direction.
MovementMethodTypePlane	Movement in arbitrary plane.
MovementMethodTypeNormal	Movement along a face normal.
MovementMethodTypeEdge	Movement along an edge.

enum NXOpen::Features::Subdivision::TransformCageData::ScalingMethodType

Scaling method.

Enumerator
ScalingMethodTypeLinear	Scale in the specified direction.
ScalingMethodTypePlanar	Scale in the plane normal to specified direction.
ScalingMethodTypeUniform	Scale uniformly all the directions.

enum NXOpen::Features::Subdivision::TransformCageData::TransformationMethodType

Transformation method types.

Enumerator
TransformationMethodTypeDrag	Edit cage topology by direct dragging.
TransformationMethodTypeTransform	Edit cage topology by transformations.

enum NXOpen::Features::Subdivision::TransformCageData::WCSOptionType

WCS principal axis or plane types.

Enumerator
WCSOptionTypeInferredAxis	Along axis inferred during movement.
WCSOptionTypeX	Along X axis.
WCSOptionTypeY	Along Y axis.
WCSOptionTypeZ	Along Z axis.
WCSOptionTypeYZ	In YZ plane.
WCSOptionTypeXZ	In XZ plane.
WCSOptionTypeXY	In XY plane.

Member Function Documentation

NXOpen::Features::Subdivision::CageManipulatorData* NXOpen::Features::Subdivision::TransformCageData::CageManipulator ( )

Returns the cage manipulation data.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::Subdivision::TransformCageData::CanMoveToolOnly ( )

Returns the flag indicating if transformer tool can be moved without transforming the selected cage topology.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::Subdivision::TransformCageData::CanRelocateToolToSelection ( )

Returns the flag indicating if transformer tool can be relocated based on cage topology selection.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Features::Subdivision::TransformCageData::CanReorientToolToSelection ( )

Returns the flag indicating if transformer tool can be reoriented based on cage topology selection.

Created in NX9.0.0.

License requirements : None

double NXOpen::Features::Subdivision::TransformCageData::FallOffFactor ( )

Returns the falloff factor.

Created in NX10.0.0.

License requirements : None

NXOpen::Features::Subdivision::TransformCageData::FallOffMethodType NXOpen::Features::Subdivision::TransformCageData::FallOffMethod ( )

Returns the falloff method.

Created in NX10.0.0.

License requirements : None

NXOpen::Features::Subdivision::SelectCageObjectData* NXOpen::Features::Subdivision::TransformCageData::FallOffObjects ( )

Returns the falloff objects.

Created in NX10.0.0.

License requirements : None

NXOpen::Features::Subdivision::TransformCageData::MovementMethodType NXOpen::Features::Subdivision::TransformCageData::MovementMethod ( )

Returns the movement method.

Created in NX9.0.0.

License requirements : None

NXOpen::Plane* NXOpen::Features::Subdivision::TransformCageData::MovementPlane ( )

Returns the movement plane.

Created in NX9.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Features::Subdivision::TransformCageData::MovementVector ( )

Returns the movement vector.

Created in NX9.0.0.

License requirements : None

void NXOpen::Features::Subdivision::TransformCageData::ResetFallOffToLinear ( )

Resets the falloff scale to linear.

Created in NX11.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

NXOpen::Features::Subdivision::TransformCageData::ScalingMethodType NXOpen::Features::Subdivision::TransformCageData::ScalingMethod ( )

Returns the scaling method.

Created in NX9.0.0.

License requirements : None

void NXOpen::Features::Subdivision::TransformCageData::SetCanMoveToolOnly ( bool canMove )

Sets the flag indicating if transformer tool can be moved without transforming the selected cage topology.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

canMove canmove

void NXOpen::Features::Subdivision::TransformCageData::SetCanRelocateToolToSelection ( bool canRelocate )

Sets the flag indicating if transformer tool can be relocated based on cage topology selection.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

canRelocate canrelocate

void NXOpen::Features::Subdivision::TransformCageData::SetCanReorientToolToSelection ( bool canReorient )

Sets the flag indicating if transformer tool can be reoriented based on cage topology selection.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

canReorient canreorient

void NXOpen::Features::Subdivision::TransformCageData::SetFallOffFactor ( double factor )

Sets the falloff factor.

Created in NX10.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

factor factor

void NXOpen::Features::Subdivision::TransformCageData::SetFallOffMethod ( NXOpen::Features::Subdivision::TransformCageData::FallOffMethodType fallOffMethod )

Sets the falloff method.

Created in NX10.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

fallOffMethod falloffmethod

void NXOpen::Features::Subdivision::TransformCageData::SetMovementMethod ( NXOpen::Features::Subdivision::TransformCageData::MovementMethodType movementMethod )

Sets the movement method.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

movementMethod movementmethod

void NXOpen::Features::Subdivision::TransformCageData::SetMovementPlane ( NXOpen::Plane * movementPlane )

Sets the movement plane.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

movementPlane movementplane

void NXOpen::Features::Subdivision::TransformCageData::SetMovementVector ( NXOpen::Direction * movementVector )

Sets the movement vector.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

movementVector movementvector

void NXOpen::Features::Subdivision::TransformCageData::SetScalingMethod ( NXOpen::Features::Subdivision::TransformCageData::ScalingMethodType scalingMethod )

Sets the scaling method.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

scalingMethod scalingmethod

void NXOpen::Features::Subdivision::TransformCageData::SetTransformationMethod ( NXOpen::Features::Subdivision::TransformCageData::TransformationMethodType method )

Sets the transformation method.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

method method

void NXOpen::Features::Subdivision::TransformCageData::SetWCSOption ( NXOpen::Features::Subdivision::TransformCageData::WCSOptionType wcsOption )

Sets the WCS option.

Created in NX9.0.0.

License requirements : nx_subdivision (" NX SUBDIVISION")

Parameters

wcsOption wcsoption

NXOpen::Features::Subdivision::TransformCageData::TransformationMethodType NXOpen::Features::Subdivision::TransformCageData::TransformationMethod ( )

Returns the transformation method.

Created in NX9.0.0.

License requirements : None

NXOpen::Features::Subdivision::TransformCageData::WCSOptionType NXOpen::Features::Subdivision::TransformCageData::WCSOption ( )

Returns the WCS option.

Created in NX9.0.0.

License requirements : None

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

Features_Subdivision_TransformCageData.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation