NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Drawings::ViewScaleBuilder Class Reference

Represents the View Scale (Drawings.ViewScaleBuilder) More...

Inheritance diagram for NXOpen::Drawings::ViewScaleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Type { TypeRatio, TypeExpression }
 The view scale type. More...
 

Public Member Functions

double Denominator ()
 Returns the scale denominator
Created in NX6.0.0. More...
 
NXOpen::ExpressionExpression ()
 Returns the scale expression
Created in NX6.0.0. More...
 
double Numerator ()
 Returns the scale numerator
Created in NX6.0.0. More...
 
NXOpen::Drawings::ViewScaleBuilder::Type ScaleType ()
 Returns the scale type
Created in NX6.0.0. More...
 
void SetDenominator (double denominator)
 Sets the scale denominator
Created in NX6.0.0. More...
 
void SetExpression (NXOpen::Expression *expression)
 Sets the scale expression
Created in NX6.0.0. More...
 
void SetNumerator (double numerator)
 Sets the scale numerator
Created in NX6.0.0. More...
 
void SetScaleType (NXOpen::Drawings::ViewScaleBuilder::Type type)
 Sets the scale type
Created in NX6.0.0. 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 the View Scale (Drawings.ViewScaleBuilder)


Created in NX6.0.0.

Member Enumeration Documentation

The view scale type.

Enumerator
TypeRatio 

determine scale from numerator / denominator

TypeExpression 

determine scale from expression

Member Function Documentation

double NXOpen::Drawings::ViewScaleBuilder::Denominator ( )

Returns the scale denominator
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Drawings::ViewScaleBuilder::Expression ( )

Returns the scale expression
Created in NX6.0.0.



License requirements : None

double NXOpen::Drawings::ViewScaleBuilder::Numerator ( )

Returns the scale numerator
Created in NX6.0.0.



License requirements : None

NXOpen::Drawings::ViewScaleBuilder::Type NXOpen::Drawings::ViewScaleBuilder::ScaleType ( )

Returns the scale type
Created in NX6.0.0.



License requirements : None

void NXOpen::Drawings::ViewScaleBuilder::SetDenominator ( double  denominator)

Sets the scale denominator
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
denominatorsets the denominator for the view's scale
void NXOpen::Drawings::ViewScaleBuilder::SetExpression ( NXOpen::Expression expression)

Sets the scale expression
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
expressionsets the expression used to determine the view scale. It will only be used if type is set to Drawings::ViewScaleBuilder::TypeExpression .
void NXOpen::Drawings::ViewScaleBuilder::SetNumerator ( double  numerator)

Sets the scale numerator
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
numeratorsets the numerator for the view's scale
void NXOpen::Drawings::ViewScaleBuilder::SetScaleType ( NXOpen::Drawings::ViewScaleBuilder::Type  type)

Sets the scale type
Created in NX6.0.0.



License requirements : drafting ("DRAFTING")

Parameters
typesets the scale type.
virtual bool NXOpen::Drawings::ViewScaleBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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