NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::Xyplot::VectorStyle2DSetting Class Reference

Represents the 2D vector display style. More...

Inheritance diagram for NXOpen::CAE::Xyplot::VectorStyle2DSetting:
NXOpen::CAE::Xyplot::BaseLineStyleSetting NXOpen::CAE::Xyplot::BaseSymbolStyleSetting NXOpen::CAE::Xyplot::BaseDisplayStyleSetting NXOpen::TaggedObject NXOpen::CAE::Xyplot::IDisplayStyle

Public Member Functions

bool DrawText ()
 Returns a value indicating whether to draw annotation text
Created in NX12.0.0. More...
 
NXOpen::NXColorGetNthVectorColor (int index)
 Get the nth vector display color. More...
 
std::vector< NXOpen::NXColor * > GetVectorColors ()
 Get the vector display colors. More...
 
bool IsAutoTextCount ()
 Returns a value indicating whether to customize annotation text count
Created in NX12.0.0. More...
 
int MaximumTextCount ()
 Returns the maximum of customized text count
Created in NX12.0.0. More...
 
bool OverlapTextAndVector ()
 Returns a value indicating whether to allow the annotation text overlap with vector
Created in NX12.0.0. More...
 
void SetAutoTextCount (bool isAutoTextCount)
 Sets a value indicating whether to customize annotation text count
Created in NX12.0.0. More...
 
void SetDrawText (bool canDrawText)
 Sets a value indicating whether to draw annotation text
Created in NX12.0.0. More...
 
void SetMaximumTextCount (int maximumTextCount)
 Sets the maximum of customized text count
Created in NX12.0.0. More...
 
void SetNthVectorColors (int index, NXOpen::NXColor *vectorColors)
 Set the nth vector display color
Created in NX12.0.0. More...
 
void SetOverlapTextAndVector (bool overlapTextAndVector)
 Sets a value indicating whether to allow the annotation text overlap with vector
Created in NX12.0.0. More...
 
void SetVectorColors (const std::vector< NXOpen::NXColor * > &vectorColors)
 Set the vector display colors
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseLineStyleSetting
NXOpen::NXColorColor ()
 Returns the line color
Created in NX9.0.0. More...
 
NXOpen::DisplayableObject::ObjectFont Font ()
 Returns the line font
Created in NX9.0.0. More...
 
void SetColor (NXOpen::NXColor *color)
 Sets the line color
Created in NX9.0.0. More...
 
void SetFont (NXOpen::DisplayableObject::ObjectFont font)
 Sets the line font
Created in NX9.0.0. More...
 
void SetWidth (NXOpen::DisplayableObject::ObjectWidth lineWidth)
 Sets the line width
Created in NX9.0.0. More...
 
NXOpen::DisplayableObject::ObjectWidth Width ()
 Returns the line width
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseSymbolStyleSetting
NXOpen::CAE::Xyplot::PointMarker PointMarker ()
 Returns the point marker
Created in NX9.0.0. More...
 
void SetPointMarker (NXOpen::CAE::Xyplot::PointMarker pointMarker)
 Sets the point marker
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAE::Xyplot::BaseDisplayStyleSetting
virtual void CommitChange ()
 Commits any edits that have been applied to the display style. More...
 
NXOpen::TaggedObjectFind (const NXString &journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXOpen::TaggedObjectFind (const char *journalIdentifier)
 Finds the NXOpen::TaggedObject with the given identifier as recorded in a journal. More...
 
NXString JournalIdentifier ()
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual
NXOpen::CAE::Xyplot::IDisplayStyle
Owner ()
 Returns the owner style
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the 2D vector display style.


Not support KF.

Created in NX12.0.0.

Member Function Documentation

bool NXOpen::CAE::Xyplot::VectorStyle2DSetting::DrawText ( )

Returns a value indicating whether to draw annotation text
Created in NX12.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::CAE::Xyplot::VectorStyle2DSetting::GetNthVectorColor ( int  index)

Get the nth vector display color.

Returns
Get the nth display vector color
Created in NX12.0.0.

License requirements : None
Parameters
indexindex
std::vector<NXOpen::NXColor *> NXOpen::CAE::Xyplot::VectorStyle2DSetting::GetVectorColors ( )

Get the vector display colors.

Returns
Get the display vector colors
Created in NX12.0.0.

License requirements : None
bool NXOpen::CAE::Xyplot::VectorStyle2DSetting::IsAutoTextCount ( )

Returns a value indicating whether to customize annotation text count
Created in NX12.0.0.



License requirements : None

int NXOpen::CAE::Xyplot::VectorStyle2DSetting::MaximumTextCount ( )

Returns the maximum of customized text count
Created in NX12.0.0.



License requirements : None

bool NXOpen::CAE::Xyplot::VectorStyle2DSetting::OverlapTextAndVector ( )

Returns a value indicating whether to allow the annotation text overlap with vector
Created in NX12.0.0.



License requirements : None

void NXOpen::CAE::Xyplot::VectorStyle2DSetting::SetAutoTextCount ( bool  isAutoTextCount)

Sets a value indicating whether to customize annotation text count
Created in NX12.0.0.



License requirements : None

Parameters
isAutoTextCountisautotextcount
void NXOpen::CAE::Xyplot::VectorStyle2DSetting::SetDrawText ( bool  canDrawText)

Sets a value indicating whether to draw annotation text
Created in NX12.0.0.



License requirements : None

Parameters
canDrawTextcandrawtext
void NXOpen::CAE::Xyplot::VectorStyle2DSetting::SetMaximumTextCount ( int  maximumTextCount)

Sets the maximum of customized text count
Created in NX12.0.0.



License requirements : None

Parameters
maximumTextCountmaximumtextcount
void NXOpen::CAE::Xyplot::VectorStyle2DSetting::SetNthVectorColors ( int  index,
NXOpen::NXColor vectorColors 
)

Set the nth vector display color
Created in NX12.0.0.



License requirements : None

Parameters
indexindex
vectorColorsSet the nth display vector color
void NXOpen::CAE::Xyplot::VectorStyle2DSetting::SetOverlapTextAndVector ( bool  overlapTextAndVector)

Sets a value indicating whether to allow the annotation text overlap with vector
Created in NX12.0.0.



License requirements : None

Parameters
overlapTextAndVectorWhether to allow the annotation text to overlap with vector
void NXOpen::CAE::Xyplot::VectorStyle2DSetting::SetVectorColors ( const std::vector< NXOpen::NXColor * > &  vectorColors)

Set the vector display colors
Created in NX12.0.0.



License requirements : None

Parameters
vectorColorsSet the display vector colors

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