Represents a Annotations::BaseFrameBarBuilder . More...

Inheritance diagram for NXOpen::Annotations::BaseFrameBarBuilder:

Public Types
enum	AxisType { AxisTypeX, AxisTypeY, AxisTypeZ }
	Enum for Ship Axis This is used by Annotations::BaseFrameBarBuilder::Axis and Annotations::BaseFrameBarBuilder::SetAxis to get/set the axis for a frame bar. More...

Public Member Functions
bool	AftPerpendicular ()
	Returns the aft perpendicular Created in NX8.0.0.

NXOpen::Annotations::BaseFrameBarBuilder::AxisType	Axis ()
	Returns the axis Created in NX8.0.0.

bool	Baseline ()
	Returns the baseline Created in NX8.0.0.

bool	BulkHeads ()
	Returns the bulk heads Created in NX8.0.0.

bool	Centerline ()
	Returns the centerline Created in NX8.0.0.

void	CreateFrameBarObject ()
	Creates frame bar object Created in NX8.0.0.

bool	Decks ()
	Returns the decks Created in NX8.0.0.

bool	ForwardPerpendicular ()
	Returns the forward perpendicular Created in NX8.0.0.

NXOpen::Annotations::BaseFrameBar *	GetFramebar ()
	The frame bar.

bool	InterTransverseFrames ()
	Returns the inter transverse frames Created in NX8.0.0.

bool	LongitudinalYFrames ()
	Returns the longitudinal yframes Created in NX8.0.0.

bool	LongitudinalZFrames ()
	Returns the longitudinal zframes Created in NX8.0.0.

NXOpen::Annotations::OriginBuilder *	Origin ()
	Returns the origin Created in NX8.0.0.

void	ReverseTics ()
	This function is used to reverse tics on the framebar Created in NX8.0.0.

void	SetAftPerpendicular (bool aftPerpendicular)
	Sets the aft perpendicular Created in NX8.0.0.

void	SetAxis (NXOpen::Annotations::BaseFrameBarBuilder::AxisType axis)
	Sets the axis Created in NX8.0.0.

void	SetBaseline (bool baseline)
	Sets the baseline Created in NX8.0.0.

void	SetBulkHeads (bool bulkHeads)
	Sets the bulk heads Created in NX8.0.0.

void	SetCenterline (bool centerline)
	Sets the centerline Created in NX8.0.0.

void	SetDecks (bool decks)
	Sets the decks Created in NX8.0.0.

void	SetForwardPerpendicular (bool forwardPerpendicular)
	Sets the forward perpendicular Created in NX8.0.0.

void	SetInterTransverseFrames (bool interTransverseFrames)
	Sets the inter transverse frames Created in NX8.0.0.

void	SetLongitudinalYFrames (bool longitudinalYFrames)
	Sets the longitudinal yframes Created in NX8.0.0.

void	SetLongitudinalZFrames (bool longitudinalZFrames)
	Sets the longitudinal zframes Created in NX8.0.0.

void	SetTransveralInsertArea (bool transveralInsertArea)
	Sets the transveral insert area Created in NX8.0.0.

void	SetTransverseFrames (bool transverseFrames)
	Sets the transverse frames Created in NX8.0.0.

void	SetWaterline (bool waterline)
	Sets the waterline Created in NX8.0.0.

NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the style Created in NX8.0.0.

bool	TransveralInsertArea ()
	Returns the transveral insert area Created in NX8.0.0.

bool	TransverseFrames ()
	Returns the transverse frames Created in NX8.0.0.

void	UpdateFrameBarFromStyle ()
	Updates frame bar object as per style Created in NX8.0.0.

void	UpdateFromConceptModel ()
	This function is used to update framebar from Concept model Created in NX8.0.0.

NXOpen::Drawings::SelectDraftingView *	View ()
	Returns the select view Created in NX8.0.0.

bool	Waterline ()
	Returns the waterline Created in NX8.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Annotations::BaseFrameBarBuilder .

This class allows to create frame bar annotation
This is an abstract class, and cannot be instantiated.

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::BaseFrameBarBuilder::AxisType

Enum for Ship Axis This is used by Annotations::BaseFrameBarBuilder::Axis and Annotations::BaseFrameBarBuilder::SetAxis to get/set the axis for a frame bar.

Enumerator:

AxisTypeX	Ship X Axis.
AxisTypeY	Ship Y Axis.
AxisTypeZ	Ship Z Axis.

Member Function Documentation

bool NXOpen::Annotations::BaseFrameBarBuilder::AftPerpendicular ( )

Returns the aft perpendicular
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::BaseFrameBarBuilder::AxisType NXOpen::Annotations::BaseFrameBarBuilder::Axis ( )

Returns the axis
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::Baseline ( )

Returns the baseline
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::BulkHeads ( )

Returns the bulk heads
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::Centerline ( )

Returns the centerline
Created in NX8.0.0.

License requirements : None

void NXOpen::Annotations::BaseFrameBarBuilder::CreateFrameBarObject ( )

Creates frame bar object
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

bool NXOpen::Annotations::BaseFrameBarBuilder::Decks ( )

Returns the decks
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::ForwardPerpendicular ( )

Returns the forward perpendicular
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::BaseFrameBar* NXOpen::Annotations::BaseFrameBarBuilder::GetFramebar ( )

The frame bar.

Returns: The frame bar
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::InterTransverseFrames ( )

Returns the inter transverse frames
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::LongitudinalYFrames ( )

Returns the longitudinal yframes
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::LongitudinalZFrames ( )

Returns the longitudinal zframes
Created in NX8.0.0.

License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::BaseFrameBarBuilder::Origin ( )

Returns the origin
Created in NX8.0.0.

License requirements : None

void NXOpen::Annotations::BaseFrameBarBuilder::ReverseTics ( )

This function is used to reverse tics on the framebar
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

void NXOpen::Annotations::BaseFrameBarBuilder::SetAftPerpendicular ( bool aftPerpendicular )

Sets the aft perpendicular
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

aftPerpendicular aftperpendicular

void NXOpen::Annotations::BaseFrameBarBuilder::SetAxis ( NXOpen::Annotations::BaseFrameBarBuilder::AxisType axis )

Sets the axis
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

axis axis

void NXOpen::Annotations::BaseFrameBarBuilder::SetBaseline ( bool baseline )

Sets the baseline
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

baseline baseline

void NXOpen::Annotations::BaseFrameBarBuilder::SetBulkHeads ( bool bulkHeads )

Sets the bulk heads
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

bulkHeads bulkheads

void NXOpen::Annotations::BaseFrameBarBuilder::SetCenterline ( bool centerline )

Sets the centerline
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

centerline centerline

void NXOpen::Annotations::BaseFrameBarBuilder::SetDecks ( bool decks )

Sets the decks
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

decks decks

void NXOpen::Annotations::BaseFrameBarBuilder::SetForwardPerpendicular ( bool forwardPerpendicular )

Sets the forward perpendicular
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

forwardPerpendicular forwardperpendicular

void NXOpen::Annotations::BaseFrameBarBuilder::SetInterTransverseFrames ( bool interTransverseFrames )

Sets the inter transverse frames
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

interTransverseFrames intertransverseframes

void NXOpen::Annotations::BaseFrameBarBuilder::SetLongitudinalYFrames ( bool longitudinalYFrames )

Sets the longitudinal yframes
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

longitudinalYFrames longitudinalyframes

void NXOpen::Annotations::BaseFrameBarBuilder::SetLongitudinalZFrames ( bool longitudinalZFrames )

Sets the longitudinal zframes
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

longitudinalZFrames longitudinalzframes

void NXOpen::Annotations::BaseFrameBarBuilder::SetTransveralInsertArea ( bool transveralInsertArea )

Sets the transveral insert area
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

transveralInsertArea transveralinsertarea

void NXOpen::Annotations::BaseFrameBarBuilder::SetTransverseFrames ( bool transverseFrames )

Sets the transverse frames
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

transverseFrames transverseframes

void NXOpen::Annotations::BaseFrameBarBuilder::SetWaterline ( bool waterline )

Sets the waterline
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

waterline waterline

NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::BaseFrameBarBuilder::Style ( )

Returns the style
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::TransveralInsertArea ( )

Returns the transveral insert area
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::TransverseFrames ( )

Returns the transverse frames
Created in NX8.0.0.

License requirements : None

void NXOpen::Annotations::BaseFrameBarBuilder::UpdateFrameBarFromStyle ( )

Updates frame bar object as per style
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

void NXOpen::Annotations::BaseFrameBarBuilder::UpdateFromConceptModel ( )

This function is used to update framebar from Concept model
Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

NXOpen::Drawings::SelectDraftingView* NXOpen::Annotations::BaseFrameBarBuilder::View ( )

Returns the select view
Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::BaseFrameBarBuilder::Waterline ( )

Returns the waterline
Created in NX8.0.0.

License requirements : None

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

Annotations_BaseFrameBarBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation