body_hash
stringlengths 64
64
| body
stringlengths 23
109k
| docstring
stringlengths 1
57k
| path
stringlengths 4
198
| name
stringlengths 1
115
| repository_name
stringlengths 7
111
| repository_stars
float64 0
191k
| lang
stringclasses 1
value | body_without_docstring
stringlengths 14
108k
| unified
stringlengths 45
133k
|
|---|---|---|---|---|---|---|---|---|---|
2c481935e18b441fee2c9217c54fac820112ae5ffdcb0a271d543bf37a3c7a01
|
def test_itemids_in_microbiologyevents_are_in_range(mimic_con, mimic_schema):
'\n Number of ITEMIDs which are not in the allowable range\n '
query = f'''
SELECT COUNT(*) FROM {mimic_schema}.microbiologyevents
WHERE SPEC_ITEMID < 70000 OR SPEC_ITEMID > 80000
OR ORG_ITEMID < 80000 OR ORG_ITEMID > 90000
OR AB_ITEMID < 90000 OR AB_ITEMID > 100000;
'''
queryresult = pd.read_sql_query(query, mimic_con)
assert (queryresult.values[0][0] == 0)
|
Number of ITEMIDs which are not in the allowable range
|
mimic-iii/tests/test_postgres_build.py
|
test_itemids_in_microbiologyevents_are_in_range
|
kingpfogel/mimic-code
| 1,626 |
python
|
def test_itemids_in_microbiologyevents_are_in_range(mimic_con, mimic_schema):
'\n \n '
query = f'
SELECT COUNT(*) FROM {mimic_schema}.microbiologyevents
WHERE SPEC_ITEMID < 70000 OR SPEC_ITEMID > 80000
OR ORG_ITEMID < 80000 OR ORG_ITEMID > 90000
OR AB_ITEMID < 90000 OR AB_ITEMID > 100000;
'
queryresult = pd.read_sql_query(query, mimic_con)
assert (queryresult.values[0][0] == 0)
|
def test_itemids_in_microbiologyevents_are_in_range(mimic_con, mimic_schema):
'\n \n '
query = f'
SELECT COUNT(*) FROM {mimic_schema}.microbiologyevents
WHERE SPEC_ITEMID < 70000 OR SPEC_ITEMID > 80000
OR ORG_ITEMID < 80000 OR ORG_ITEMID > 90000
OR AB_ITEMID < 90000 OR AB_ITEMID > 100000;
'
queryresult = pd.read_sql_query(query, mimic_con)
assert (queryresult.values[0][0] == 0)<|docstring|>Number of ITEMIDs which are not in the allowable range<|endoftext|>
|
ee88fc53b0145e010f974e8572e7448f03edb0922200e593b449766c0015b346
|
def __init__(self, loss=NLLLoss(), batch_size=64):
'Initialize the evaluator with loss and batch size.\n\n Args:\n loss (Optional[seq2seq.loss]): Loss to count. Defaults to seq2seq.loss.NLLLoss.\n batch_size (Optional[int]): Batch size. Defaults to 64.\n\n '
self.loss = loss
self.batch_size = batch_size
|
Initialize the evaluator with loss and batch size.
Args:
loss (Optional[seq2seq.loss]): Loss to count. Defaults to seq2seq.loss.NLLLoss.
batch_size (Optional[int]): Batch size. Defaults to 64.
|
src/models/conversational/evaluator.py
|
__init__
|
Neronuser/EmoCourseChat
| 1 |
python
|
def __init__(self, loss=NLLLoss(), batch_size=64):
'Initialize the evaluator with loss and batch size.\n\n Args:\n loss (Optional[seq2seq.loss]): Loss to count. Defaults to seq2seq.loss.NLLLoss.\n batch_size (Optional[int]): Batch size. Defaults to 64.\n\n '
self.loss = loss
self.batch_size = batch_size
|
def __init__(self, loss=NLLLoss(), batch_size=64):
'Initialize the evaluator with loss and batch size.\n\n Args:\n loss (Optional[seq2seq.loss]): Loss to count. Defaults to seq2seq.loss.NLLLoss.\n batch_size (Optional[int]): Batch size. Defaults to 64.\n\n '
self.loss = loss
self.batch_size = batch_size<|docstring|>Initialize the evaluator with loss and batch size.
Args:
loss (Optional[seq2seq.loss]): Loss to count. Defaults to seq2seq.loss.NLLLoss.
batch_size (Optional[int]): Batch size. Defaults to 64.<|endoftext|>
|
2fe801c43f25eeea24ab77e7836471b195efaad706f488ec36f59302ccb749f9
|
def evaluate(self, model, data):
'Evaluate a model on given dataset and return performance.\n Args:\n model (seq2seq.models): Model to evaluate.\n data (torchtext.data.Dataset): Dataset to evaluate against.\n Returns:\n loss (float): Loss of the given model on the given dataset.\n\n '
model.eval()
loss = self.loss
loss.reset()
match = 0
total = 0
device = (None if torch.cuda.is_available() else (- 1))
batch_iterator = torchtext.data.BucketIterator(dataset=data, batch_size=self.batch_size, sort=True, sort_key=(lambda x: len(x.src)), device=device, train=False)
pad = PAD_INDEX
for batch in batch_iterator:
(input_variables, input_lengths) = getattr(batch, UTTERANCE_FIELD_NAME)
target_variables = getattr(batch, RESPONSE_FIELD_NAME)
(decoder_outputs, decoder_hidden, other) = model(input_variables, input_lengths.tolist(), target_variables)
seqlist = other['sequence']
for (step, step_output) in enumerate(decoder_outputs):
target = target_variables[(:, (step + 1))]
loss.eval_batch(step_output.view(target_variables.size(0), (- 1)), target)
non_padding = target.ne(pad)
correct = seqlist[step].view((- 1)).eq(target).masked_select(non_padding).sum().data[0]
match += correct
total += non_padding.sum().data[0]
if (total == 0):
accuracy = float('nan')
else:
accuracy = (match / total)
return (loss.get_loss(), accuracy)
|
Evaluate a model on given dataset and return performance.
Args:
model (seq2seq.models): Model to evaluate.
data (torchtext.data.Dataset): Dataset to evaluate against.
Returns:
loss (float): Loss of the given model on the given dataset.
|
src/models/conversational/evaluator.py
|
evaluate
|
Neronuser/EmoCourseChat
| 1 |
python
|
def evaluate(self, model, data):
'Evaluate a model on given dataset and return performance.\n Args:\n model (seq2seq.models): Model to evaluate.\n data (torchtext.data.Dataset): Dataset to evaluate against.\n Returns:\n loss (float): Loss of the given model on the given dataset.\n\n '
model.eval()
loss = self.loss
loss.reset()
match = 0
total = 0
device = (None if torch.cuda.is_available() else (- 1))
batch_iterator = torchtext.data.BucketIterator(dataset=data, batch_size=self.batch_size, sort=True, sort_key=(lambda x: len(x.src)), device=device, train=False)
pad = PAD_INDEX
for batch in batch_iterator:
(input_variables, input_lengths) = getattr(batch, UTTERANCE_FIELD_NAME)
target_variables = getattr(batch, RESPONSE_FIELD_NAME)
(decoder_outputs, decoder_hidden, other) = model(input_variables, input_lengths.tolist(), target_variables)
seqlist = other['sequence']
for (step, step_output) in enumerate(decoder_outputs):
target = target_variables[(:, (step + 1))]
loss.eval_batch(step_output.view(target_variables.size(0), (- 1)), target)
non_padding = target.ne(pad)
correct = seqlist[step].view((- 1)).eq(target).masked_select(non_padding).sum().data[0]
match += correct
total += non_padding.sum().data[0]
if (total == 0):
accuracy = float('nan')
else:
accuracy = (match / total)
return (loss.get_loss(), accuracy)
|
def evaluate(self, model, data):
'Evaluate a model on given dataset and return performance.\n Args:\n model (seq2seq.models): Model to evaluate.\n data (torchtext.data.Dataset): Dataset to evaluate against.\n Returns:\n loss (float): Loss of the given model on the given dataset.\n\n '
model.eval()
loss = self.loss
loss.reset()
match = 0
total = 0
device = (None if torch.cuda.is_available() else (- 1))
batch_iterator = torchtext.data.BucketIterator(dataset=data, batch_size=self.batch_size, sort=True, sort_key=(lambda x: len(x.src)), device=device, train=False)
pad = PAD_INDEX
for batch in batch_iterator:
(input_variables, input_lengths) = getattr(batch, UTTERANCE_FIELD_NAME)
target_variables = getattr(batch, RESPONSE_FIELD_NAME)
(decoder_outputs, decoder_hidden, other) = model(input_variables, input_lengths.tolist(), target_variables)
seqlist = other['sequence']
for (step, step_output) in enumerate(decoder_outputs):
target = target_variables[(:, (step + 1))]
loss.eval_batch(step_output.view(target_variables.size(0), (- 1)), target)
non_padding = target.ne(pad)
correct = seqlist[step].view((- 1)).eq(target).masked_select(non_padding).sum().data[0]
match += correct
total += non_padding.sum().data[0]
if (total == 0):
accuracy = float('nan')
else:
accuracy = (match / total)
return (loss.get_loss(), accuracy)<|docstring|>Evaluate a model on given dataset and return performance.
Args:
model (seq2seq.models): Model to evaluate.
data (torchtext.data.Dataset): Dataset to evaluate against.
Returns:
loss (float): Loss of the given model on the given dataset.<|endoftext|>
|
a165f723431bb5a433cd59e380396a9a7c897de33dc28e6130916ef4ef1139b2
|
def evaluate(self, model, data):
'Evaluate a model on given dataset and return performance.\n Args:\n model (seq2seq.models): Model to evaluate.\n data (torchtext.data.Dataset): Dataset to evaluate against.\n Returns:\n loss (float): Loss of the given model on the given dataset.\n\n '
model.eval()
loss = self.loss
loss.reset()
match = 0
total = 0
device = (None if torch.cuda.is_available() else (- 1))
batch_iterator = torchtext.data.BucketIterator(dataset=data, batch_size=self.batch_size, sort=True, sort_key=(lambda x: len(x.src)), device=device, train=False)
pad = PAD_INDEX
for batch in batch_iterator:
(input_variables, input_lengths) = getattr(batch, UTTERANCE_FIELD_NAME)
target_variables = getattr(batch, RESPONSE_FIELD_NAME)
emotion_variables = getattr(batch, EMOTION_FIELD_NAME)
(decoder_outputs, decoder_hidden, other) = model(input_variables, input_lengths.tolist(), target_variables, emotion_variables)
seqlist = other['sequence']
for (step, step_output) in enumerate(decoder_outputs):
target = target_variables[(:, (step + 1))]
loss.eval_batch(step_output.view(target_variables.size(0), (- 1)), target)
non_padding = target.ne(pad)
correct = seqlist[step].view((- 1)).eq(target).masked_select(non_padding).sum().data[0]
match += correct
total += non_padding.sum().data[0]
if (total == 0):
accuracy = float('nan')
else:
accuracy = (match / total)
return (loss.get_loss(), accuracy)
|
Evaluate a model on given dataset and return performance.
Args:
model (seq2seq.models): Model to evaluate.
data (torchtext.data.Dataset): Dataset to evaluate against.
Returns:
loss (float): Loss of the given model on the given dataset.
|
src/models/conversational/evaluator.py
|
evaluate
|
Neronuser/EmoCourseChat
| 1 |
python
|
def evaluate(self, model, data):
'Evaluate a model on given dataset and return performance.\n Args:\n model (seq2seq.models): Model to evaluate.\n data (torchtext.data.Dataset): Dataset to evaluate against.\n Returns:\n loss (float): Loss of the given model on the given dataset.\n\n '
model.eval()
loss = self.loss
loss.reset()
match = 0
total = 0
device = (None if torch.cuda.is_available() else (- 1))
batch_iterator = torchtext.data.BucketIterator(dataset=data, batch_size=self.batch_size, sort=True, sort_key=(lambda x: len(x.src)), device=device, train=False)
pad = PAD_INDEX
for batch in batch_iterator:
(input_variables, input_lengths) = getattr(batch, UTTERANCE_FIELD_NAME)
target_variables = getattr(batch, RESPONSE_FIELD_NAME)
emotion_variables = getattr(batch, EMOTION_FIELD_NAME)
(decoder_outputs, decoder_hidden, other) = model(input_variables, input_lengths.tolist(), target_variables, emotion_variables)
seqlist = other['sequence']
for (step, step_output) in enumerate(decoder_outputs):
target = target_variables[(:, (step + 1))]
loss.eval_batch(step_output.view(target_variables.size(0), (- 1)), target)
non_padding = target.ne(pad)
correct = seqlist[step].view((- 1)).eq(target).masked_select(non_padding).sum().data[0]
match += correct
total += non_padding.sum().data[0]
if (total == 0):
accuracy = float('nan')
else:
accuracy = (match / total)
return (loss.get_loss(), accuracy)
|
def evaluate(self, model, data):
'Evaluate a model on given dataset and return performance.\n Args:\n model (seq2seq.models): Model to evaluate.\n data (torchtext.data.Dataset): Dataset to evaluate against.\n Returns:\n loss (float): Loss of the given model on the given dataset.\n\n '
model.eval()
loss = self.loss
loss.reset()
match = 0
total = 0
device = (None if torch.cuda.is_available() else (- 1))
batch_iterator = torchtext.data.BucketIterator(dataset=data, batch_size=self.batch_size, sort=True, sort_key=(lambda x: len(x.src)), device=device, train=False)
pad = PAD_INDEX
for batch in batch_iterator:
(input_variables, input_lengths) = getattr(batch, UTTERANCE_FIELD_NAME)
target_variables = getattr(batch, RESPONSE_FIELD_NAME)
emotion_variables = getattr(batch, EMOTION_FIELD_NAME)
(decoder_outputs, decoder_hidden, other) = model(input_variables, input_lengths.tolist(), target_variables, emotion_variables)
seqlist = other['sequence']
for (step, step_output) in enumerate(decoder_outputs):
target = target_variables[(:, (step + 1))]
loss.eval_batch(step_output.view(target_variables.size(0), (- 1)), target)
non_padding = target.ne(pad)
correct = seqlist[step].view((- 1)).eq(target).masked_select(non_padding).sum().data[0]
match += correct
total += non_padding.sum().data[0]
if (total == 0):
accuracy = float('nan')
else:
accuracy = (match / total)
return (loss.get_loss(), accuracy)<|docstring|>Evaluate a model on given dataset and return performance.
Args:
model (seq2seq.models): Model to evaluate.
data (torchtext.data.Dataset): Dataset to evaluate against.
Returns:
loss (float): Loss of the given model on the given dataset.<|endoftext|>
|
49fc44802097ae2c4fc73b1276674b15fe7d87874edab696d20722cc31d4fd32
|
def hash_passwd(passwd):
'Hash the user password.\n\n Raspberry Pi OS currently supports no better methon than sha256.\n '
return crypt.crypt(passwd, salt=crypt.mksalt(crypt.METHOD_SHA256))
|
Hash the user password.
Raspberry Pi OS currently supports no better methon than sha256.
|
src/bake_a_py/provisioning.py
|
hash_passwd
|
derSuessmann/bake-a-py
| 0 |
python
|
def hash_passwd(passwd):
'Hash the user password.\n\n Raspberry Pi OS currently supports no better methon than sha256.\n '
return crypt.crypt(passwd, salt=crypt.mksalt(crypt.METHOD_SHA256))
|
def hash_passwd(passwd):
'Hash the user password.\n\n Raspberry Pi OS currently supports no better methon than sha256.\n '
return crypt.crypt(passwd, salt=crypt.mksalt(crypt.METHOD_SHA256))<|docstring|>Hash the user password.
Raspberry Pi OS currently supports no better methon than sha256.<|endoftext|>
|
f226f135923b222b99484b47476805287976b76614c54995dd508078537c0c98
|
@pytest.fixture
def solver():
'Return a solver object as a fixture.'
import rosalind
return rosalind.Solver
|
Return a solver object as a fixture.
|
test_solutions.py
|
solver
|
honzo0481/rosalind
| 0 |
python
|
@pytest.fixture
def solver():
import rosalind
return rosalind.Solver
|
@pytest.fixture
def solver():
import rosalind
return rosalind.Solver<|docstring|>Return a solver object as a fixture.<|endoftext|>
|
e599b7cdb49b44ff9e4b91a183578d3ab75b9d029ed7a9578c87d847d4df19ca
|
def load_csv(filepath, cols=None):
'Load data from a csv.'
with open(filepath) as f:
reader = csv.reader(f)
if (cols is None):
data = [row for row in reader]
else:
data = [[row[col] for col in sorted(cols)] for row in reader if (len(row) > 0)]
return data[1:]
|
Load data from a csv.
|
test_solutions.py
|
load_csv
|
honzo0481/rosalind
| 0 |
python
|
def load_csv(filepath, cols=None):
with open(filepath) as f:
reader = csv.reader(f)
if (cols is None):
data = [row for row in reader]
else:
data = [[row[col] for col in sorted(cols)] for row in reader if (len(row) > 0)]
return data[1:]
|
def load_csv(filepath, cols=None):
with open(filepath) as f:
reader = csv.reader(f)
if (cols is None):
data = [row for row in reader]
else:
data = [[row[col] for col in sorted(cols)] for row in reader if (len(row) > 0)]
return data[1:]<|docstring|>Load data from a csv.<|endoftext|>
|
2c5a271087e711f77afee71b4b38487cae7f7e2e9fd1a063a411ca72e94f6745
|
@pytest.mark.parametrize('input_data, output_data', load_csv('test_data.csv', cols=(1, 2)))
def test_in_ne_out(input_data, output_data):
'Input should never equal output.'
assert (input_data != output_data)
|
Input should never equal output.
|
test_solutions.py
|
test_in_ne_out
|
honzo0481/rosalind
| 0 |
python
|
@pytest.mark.parametrize('input_data, output_data', load_csv('test_data.csv', cols=(1, 2)))
def test_in_ne_out(input_data, output_data):
assert (input_data != output_data)
|
@pytest.mark.parametrize('input_data, output_data', load_csv('test_data.csv', cols=(1, 2)))
def test_in_ne_out(input_data, output_data):
assert (input_data != output_data)<|docstring|>Input should never equal output.<|endoftext|>
|
19b33a6fefd2fce9f2836ec72ed176ab6d5bdf79b4dc6ced998435cdea85b20c
|
@pytest.mark.parametrize('problem, input_data, output_data', load_csv('test_data.csv'))
def test_solution(solver, problem, input_data, output_data):
'Output from problem function given input_data should exactly match output_data.'
solver = solver()
try:
solver = getattr(solver, problem.lower())
except AttributeError:
solver = str
assert (solver(input_data) == output_data), problem
|
Output from problem function given input_data should exactly match output_data.
|
test_solutions.py
|
test_solution
|
honzo0481/rosalind
| 0 |
python
|
@pytest.mark.parametrize('problem, input_data, output_data', load_csv('test_data.csv'))
def test_solution(solver, problem, input_data, output_data):
solver = solver()
try:
solver = getattr(solver, problem.lower())
except AttributeError:
solver = str
assert (solver(input_data) == output_data), problem
|
@pytest.mark.parametrize('problem, input_data, output_data', load_csv('test_data.csv'))
def test_solution(solver, problem, input_data, output_data):
solver = solver()
try:
solver = getattr(solver, problem.lower())
except AttributeError:
solver = str
assert (solver(input_data) == output_data), problem<|docstring|>Output from problem function given input_data should exactly match output_data.<|endoftext|>
|
9b22bc9f638930575611c3e00cf5c835a62f6838468e1bf37721f83c8992588c
|
def setUp(self):
'\n Configure an instance of IntentParserServer for spellcheck testing.\n '
if os.path.exists(IntentParserServer.LINK_PREF_PATH):
for file in os.listdir(IntentParserServer.LINK_PREF_PATH):
os.remove(os.path.join(IntentParserServer.LINK_PREF_PATH, file))
os.rmdir(IntentParserServer.LINK_PREF_PATH)
self.doc_content = None
with open(os.path.join(self.dataDir, self.spellcheckFile), 'r') as fin:
self.doc_content = json.loads(fin.read())
if (self.doc_content is None):
self.fail(('Failed to read in test document! Path: ' + os.path.join(self.dataDir, self.spellcheckFile)))
self.doc_id = '1xMqOx9zZ7h2BIxSdWp2Vwi672iZ30N_2oPs8rwGUoTA'
self.user = 'bbnTest'
self.user_email = '[email protected]'
self.json_body = {'documentId': self.doc_id, 'user': self.user, 'userEmail': self.user_email}
self.google_accessor = GoogleAccessor.create()
self.template_spreadsheet_id = '1r3CIyv75vV7A7ghkB0od-TM_16qSYd-byAbQ1DhRgB0'
self.spreadsheet_id = self.google_accessor.copy_file(file_id=self.template_spreadsheet_id, new_title='Intent Parser Server Test Sheet')
self.sbh_collection_uri = 'https://hub-staging.sd2e.org/user/sd2e/src/intent_parser_collection/1'
curr_path = os.path.dirname(os.path.realpath(__file__))
with open(os.path.join(curr_path, 'sbh_creds.json'), 'r') as file:
creds = json.load(file)
self.sbh_username = creds['username']
self.sbh_password = creds['password']
self.ips = IntentParserServer(bind_port=8081, bind_ip='0.0.0.0', sbh_collection_uri=self.sbh_collection_uri, spreadsheet_id=self.spreadsheet_id, sbh_username=self.sbh_username, sbh_password=self.sbh_password)
self.ips.start(background=True)
self.ips.analyze_processing_map_lock = Mock()
self.ips.client_state_lock = Mock()
self.ips.client_state_map = {}
self.ips.google_accessor = Mock()
self.ips.google_accessor.get_document = Mock(return_value=self.doc_content)
self.ips.send_response = Mock()
self.ips.get_json_body = Mock(return_value=self.json_body)
self.ips.analyze_processing_map = {}
self.ips.analyze_processing_lock = {}
self.ips.item_map_lock = Mock()
with open(os.path.join(self.dataDir, self.items_json), 'r') as fin:
self.ips.item_map = json.load(fin)
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue((actions[0]['action'] == 'showProgressbar'))
startTime = time.time()
while ((actions[0]['action'] != 'highlightText') and ((time.time() - startTime) < 100)):
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue(((actions[0]['action'] == 'highlightText') or (actions[0]['action'] == 'updateProgress')))
time.sleep(0.25)
self.assertTrue((actions[0]['action'] == 'highlightText'))
self.assertTrue((actions[1]['action'] == 'showSidebar'))
self.search_gt = None
with open(os.path.join(self.dataDir, self.searchResults), 'rb') as fin:
self.search_gt = pickle.load(fin)
if (self.search_gt is None):
self.fail(('Failed to read in spelling results! Path: ' + os.path.join(self.dataDir, self.spellcheckResults)))
compare_search_results(self.search_gt, self.ips.client_state_map[self.doc_id]['search_results'])
|
Configure an instance of IntentParserServer for spellcheck testing.
|
intent_parser/tests/test_unit_ips_analyze_sd2dict.py
|
setUp
|
SD2E/experimental-intent-parser-mw
| 0 |
python
|
def setUp(self):
'\n \n '
if os.path.exists(IntentParserServer.LINK_PREF_PATH):
for file in os.listdir(IntentParserServer.LINK_PREF_PATH):
os.remove(os.path.join(IntentParserServer.LINK_PREF_PATH, file))
os.rmdir(IntentParserServer.LINK_PREF_PATH)
self.doc_content = None
with open(os.path.join(self.dataDir, self.spellcheckFile), 'r') as fin:
self.doc_content = json.loads(fin.read())
if (self.doc_content is None):
self.fail(('Failed to read in test document! Path: ' + os.path.join(self.dataDir, self.spellcheckFile)))
self.doc_id = '1xMqOx9zZ7h2BIxSdWp2Vwi672iZ30N_2oPs8rwGUoTA'
self.user = 'bbnTest'
self.user_email = '[email protected]'
self.json_body = {'documentId': self.doc_id, 'user': self.user, 'userEmail': self.user_email}
self.google_accessor = GoogleAccessor.create()
self.template_spreadsheet_id = '1r3CIyv75vV7A7ghkB0od-TM_16qSYd-byAbQ1DhRgB0'
self.spreadsheet_id = self.google_accessor.copy_file(file_id=self.template_spreadsheet_id, new_title='Intent Parser Server Test Sheet')
self.sbh_collection_uri = 'https://hub-staging.sd2e.org/user/sd2e/src/intent_parser_collection/1'
curr_path = os.path.dirname(os.path.realpath(__file__))
with open(os.path.join(curr_path, 'sbh_creds.json'), 'r') as file:
creds = json.load(file)
self.sbh_username = creds['username']
self.sbh_password = creds['password']
self.ips = IntentParserServer(bind_port=8081, bind_ip='0.0.0.0', sbh_collection_uri=self.sbh_collection_uri, spreadsheet_id=self.spreadsheet_id, sbh_username=self.sbh_username, sbh_password=self.sbh_password)
self.ips.start(background=True)
self.ips.analyze_processing_map_lock = Mock()
self.ips.client_state_lock = Mock()
self.ips.client_state_map = {}
self.ips.google_accessor = Mock()
self.ips.google_accessor.get_document = Mock(return_value=self.doc_content)
self.ips.send_response = Mock()
self.ips.get_json_body = Mock(return_value=self.json_body)
self.ips.analyze_processing_map = {}
self.ips.analyze_processing_lock = {}
self.ips.item_map_lock = Mock()
with open(os.path.join(self.dataDir, self.items_json), 'r') as fin:
self.ips.item_map = json.load(fin)
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue((actions[0]['action'] == 'showProgressbar'))
startTime = time.time()
while ((actions[0]['action'] != 'highlightText') and ((time.time() - startTime) < 100)):
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue(((actions[0]['action'] == 'highlightText') or (actions[0]['action'] == 'updateProgress')))
time.sleep(0.25)
self.assertTrue((actions[0]['action'] == 'highlightText'))
self.assertTrue((actions[1]['action'] == 'showSidebar'))
self.search_gt = None
with open(os.path.join(self.dataDir, self.searchResults), 'rb') as fin:
self.search_gt = pickle.load(fin)
if (self.search_gt is None):
self.fail(('Failed to read in spelling results! Path: ' + os.path.join(self.dataDir, self.spellcheckResults)))
compare_search_results(self.search_gt, self.ips.client_state_map[self.doc_id]['search_results'])
|
def setUp(self):
'\n \n '
if os.path.exists(IntentParserServer.LINK_PREF_PATH):
for file in os.listdir(IntentParserServer.LINK_PREF_PATH):
os.remove(os.path.join(IntentParserServer.LINK_PREF_PATH, file))
os.rmdir(IntentParserServer.LINK_PREF_PATH)
self.doc_content = None
with open(os.path.join(self.dataDir, self.spellcheckFile), 'r') as fin:
self.doc_content = json.loads(fin.read())
if (self.doc_content is None):
self.fail(('Failed to read in test document! Path: ' + os.path.join(self.dataDir, self.spellcheckFile)))
self.doc_id = '1xMqOx9zZ7h2BIxSdWp2Vwi672iZ30N_2oPs8rwGUoTA'
self.user = 'bbnTest'
self.user_email = '[email protected]'
self.json_body = {'documentId': self.doc_id, 'user': self.user, 'userEmail': self.user_email}
self.google_accessor = GoogleAccessor.create()
self.template_spreadsheet_id = '1r3CIyv75vV7A7ghkB0od-TM_16qSYd-byAbQ1DhRgB0'
self.spreadsheet_id = self.google_accessor.copy_file(file_id=self.template_spreadsheet_id, new_title='Intent Parser Server Test Sheet')
self.sbh_collection_uri = 'https://hub-staging.sd2e.org/user/sd2e/src/intent_parser_collection/1'
curr_path = os.path.dirname(os.path.realpath(__file__))
with open(os.path.join(curr_path, 'sbh_creds.json'), 'r') as file:
creds = json.load(file)
self.sbh_username = creds['username']
self.sbh_password = creds['password']
self.ips = IntentParserServer(bind_port=8081, bind_ip='0.0.0.0', sbh_collection_uri=self.sbh_collection_uri, spreadsheet_id=self.spreadsheet_id, sbh_username=self.sbh_username, sbh_password=self.sbh_password)
self.ips.start(background=True)
self.ips.analyze_processing_map_lock = Mock()
self.ips.client_state_lock = Mock()
self.ips.client_state_map = {}
self.ips.google_accessor = Mock()
self.ips.google_accessor.get_document = Mock(return_value=self.doc_content)
self.ips.send_response = Mock()
self.ips.get_json_body = Mock(return_value=self.json_body)
self.ips.analyze_processing_map = {}
self.ips.analyze_processing_lock = {}
self.ips.item_map_lock = Mock()
with open(os.path.join(self.dataDir, self.items_json), 'r') as fin:
self.ips.item_map = json.load(fin)
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue((actions[0]['action'] == 'showProgressbar'))
startTime = time.time()
while ((actions[0]['action'] != 'highlightText') and ((time.time() - startTime) < 100)):
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue(((actions[0]['action'] == 'highlightText') or (actions[0]['action'] == 'updateProgress')))
time.sleep(0.25)
self.assertTrue((actions[0]['action'] == 'highlightText'))
self.assertTrue((actions[1]['action'] == 'showSidebar'))
self.search_gt = None
with open(os.path.join(self.dataDir, self.searchResults), 'rb') as fin:
self.search_gt = pickle.load(fin)
if (self.search_gt is None):
self.fail(('Failed to read in spelling results! Path: ' + os.path.join(self.dataDir, self.spellcheckResults)))
compare_search_results(self.search_gt, self.ips.client_state_map[self.doc_id]['search_results'])<|docstring|>Configure an instance of IntentParserServer for spellcheck testing.<|endoftext|>
|
3026ca526020ee65dbbc898c97d56f2f1bfe332456a215f64af2afb415514c8b
|
def test_maximal_search(self):
'\n Test that the maximal search is finding different results.\n '
culled_results = self.ips.client_state_map[self.doc_id]['search_results']
self.ips.cull_overlapping = Mock(side_effect=self.return_value)
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue((actions[0]['action'] == 'showProgressbar'))
startTime = time.time()
while ((actions[0]['action'] != 'highlightText') and ((time.time() - startTime) < 100)):
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue(((actions[0]['action'] == 'highlightText') or (actions[0]['action'] == 'updateProgress')))
time.sleep(0.25)
self.assertTrue((actions[0]['action'] == 'highlightText'))
self.assertTrue((actions[1]['action'] == 'showSidebar'))
unculled_results = self.ips.client_state_map[self.doc_id]['search_results']
self.assertFalse(compare_search_results(unculled_results, culled_results))
|
Test that the maximal search is finding different results.
|
intent_parser/tests/test_unit_ips_analyze_sd2dict.py
|
test_maximal_search
|
SD2E/experimental-intent-parser-mw
| 0 |
python
|
def test_maximal_search(self):
'\n \n '
culled_results = self.ips.client_state_map[self.doc_id]['search_results']
self.ips.cull_overlapping = Mock(side_effect=self.return_value)
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue((actions[0]['action'] == 'showProgressbar'))
startTime = time.time()
while ((actions[0]['action'] != 'highlightText') and ((time.time() - startTime) < 100)):
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue(((actions[0]['action'] == 'highlightText') or (actions[0]['action'] == 'updateProgress')))
time.sleep(0.25)
self.assertTrue((actions[0]['action'] == 'highlightText'))
self.assertTrue((actions[1]['action'] == 'showSidebar'))
unculled_results = self.ips.client_state_map[self.doc_id]['search_results']
self.assertFalse(compare_search_results(unculled_results, culled_results))
|
def test_maximal_search(self):
'\n \n '
culled_results = self.ips.client_state_map[self.doc_id]['search_results']
self.ips.cull_overlapping = Mock(side_effect=self.return_value)
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue((actions[0]['action'] == 'showProgressbar'))
startTime = time.time()
while ((actions[0]['action'] != 'highlightText') and ((time.time() - startTime) < 100)):
self.ips.process_analyze_document([], [])
pa_results = json.loads(self.ips.send_response.call_args[0][1])
actions = pa_results['actions']
self.assertTrue(((actions[0]['action'] == 'highlightText') or (actions[0]['action'] == 'updateProgress')))
time.sleep(0.25)
self.assertTrue((actions[0]['action'] == 'highlightText'))
self.assertTrue((actions[1]['action'] == 'showSidebar'))
unculled_results = self.ips.client_state_map[self.doc_id]['search_results']
self.assertFalse(compare_search_results(unculled_results, culled_results))<|docstring|>Test that the maximal search is finding different results.<|endoftext|>
|
96249feb277f0424617798c1a93609165a56b8dbf090c9402a999fc6b3c34f51
|
def test_analyze_basic(self):
'\n Basic check, ensure that spellcheck runs and the results are as expected\n '
self.assertTrue((self.ips.client_state_map[self.doc_id]['document_id'] == self.doc_id))
self.assertTrue((self.ips.client_state_map[self.doc_id]['search_result_index'] is 1))
self.assertTrue((len(self.ips.client_state_map[self.doc_id]['search_results']) is self.expected_search_size))
self.assertTrue(compare_search_results(self.search_gt, self.ips.client_state_map[self.doc_id]['search_results']), 'Search result sets do not match!')
|
Basic check, ensure that spellcheck runs and the results are as expected
|
intent_parser/tests/test_unit_ips_analyze_sd2dict.py
|
test_analyze_basic
|
SD2E/experimental-intent-parser-mw
| 0 |
python
|
def test_analyze_basic(self):
'\n \n '
self.assertTrue((self.ips.client_state_map[self.doc_id]['document_id'] == self.doc_id))
self.assertTrue((self.ips.client_state_map[self.doc_id]['search_result_index'] is 1))
self.assertTrue((len(self.ips.client_state_map[self.doc_id]['search_results']) is self.expected_search_size))
self.assertTrue(compare_search_results(self.search_gt, self.ips.client_state_map[self.doc_id]['search_results']), 'Search result sets do not match!')
|
def test_analyze_basic(self):
'\n \n '
self.assertTrue((self.ips.client_state_map[self.doc_id]['document_id'] == self.doc_id))
self.assertTrue((self.ips.client_state_map[self.doc_id]['search_result_index'] is 1))
self.assertTrue((len(self.ips.client_state_map[self.doc_id]['search_results']) is self.expected_search_size))
self.assertTrue(compare_search_results(self.search_gt, self.ips.client_state_map[self.doc_id]['search_results']), 'Search result sets do not match!')<|docstring|>Basic check, ensure that spellcheck runs and the results are as expected<|endoftext|>
|
c5616b8a27288989f0afff2485db97cbf134f984dfcd29c235018aeb2fb55369
|
def test_analyze_process(self):
'\n Test that goes through the whole results in some fashion\n '
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_no_to_all([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_link_all({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
|
Test that goes through the whole results in some fashion
|
intent_parser/tests/test_unit_ips_analyze_sd2dict.py
|
test_analyze_process
|
SD2E/experimental-intent-parser-mw
| 0 |
python
|
def test_analyze_process(self):
'\n \n '
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_no_to_all([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_link_all({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
|
def test_analyze_process(self):
'\n \n '
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_no_to_all([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_yes({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_link_all({'data': {'buttonId': 'test'}}, self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])
result = self.ips.process_analyze_no([], self.ips.client_state_map[self.doc_id])<|docstring|>Test that goes through the whole results in some fashion<|endoftext|>
|
dd0eaa3574d6b83784ecba2944adbe3d6646d2eb40231a2bab2c910978b6da1b
|
def tearDown(self):
'\n Perform teardown.\n '
self.ips.stop()
|
Perform teardown.
|
intent_parser/tests/test_unit_ips_analyze_sd2dict.py
|
tearDown
|
SD2E/experimental-intent-parser-mw
| 0 |
python
|
def tearDown(self):
'\n \n '
self.ips.stop()
|
def tearDown(self):
'\n \n '
self.ips.stop()<|docstring|>Perform teardown.<|endoftext|>
|
b12bd3087e701ffaf39cf9d07a798c2c8e3563e8e3c3f401e344e8987075b9d1
|
def read_airspy_data(filename):
'\n read_airspy_data:\n \n Reads data recorded using the airspy. Returns a time series.\n \n Args:\n filename (string)\n \n Returns:\n data (int array)\n '
return (np.fromfile(filename, dtype='int16') - (2 ** 11))
|
read_airspy_data:
Reads data recorded using the airspy. Returns a time series.
Args:
filename (string)
Returns:
data (int array)
|
src/ast2050/lab3.py
|
read_airspy_data
|
jamesmlane/AST2050-Labs
| 0 |
python
|
def read_airspy_data(filename):
'\n read_airspy_data:\n \n Reads data recorded using the airspy. Returns a time series.\n \n Args:\n filename (string)\n \n Returns:\n data (int array)\n '
return (np.fromfile(filename, dtype='int16') - (2 ** 11))
|
def read_airspy_data(filename):
'\n read_airspy_data:\n \n Reads data recorded using the airspy. Returns a time series.\n \n Args:\n filename (string)\n \n Returns:\n data (int array)\n '
return (np.fromfile(filename, dtype='int16') - (2 ** 11))<|docstring|>read_airspy_data:
Reads data recorded using the airspy. Returns a time series.
Args:
filename (string)
Returns:
data (int array)<|endoftext|>
|
82f3cc753a8b7662060d3bef44f363496c9a5609cb608da4e1857873abd75db3
|
def calculate_galactic_longitude_radec(lon):
'calculate_galactic_longitude_radec:\n \n Calculate the RA / Dec of a point in the plane of the galaxy.\n \n Args:\n lon (float) - galactic longitude\n \n Returns:\n (Ra,Dec)\n '
coord_gal = SkyCoord(l=(lon * apu.deg), b=(np.zeros_like(lon) * apu.deg), frame='galactic')
coord_icrs = coord_gal.icrs
return (coord_icrs.ra.value, coord_icrs.dec.value)
|
calculate_galactic_longitude_radec:
Calculate the RA / Dec of a point in the plane of the galaxy.
Args:
lon (float) - galactic longitude
Returns:
(Ra,Dec)
|
src/ast2050/lab3.py
|
calculate_galactic_longitude_radec
|
jamesmlane/AST2050-Labs
| 0 |
python
|
def calculate_galactic_longitude_radec(lon):
'calculate_galactic_longitude_radec:\n \n Calculate the RA / Dec of a point in the plane of the galaxy.\n \n Args:\n lon (float) - galactic longitude\n \n Returns:\n (Ra,Dec)\n '
coord_gal = SkyCoord(l=(lon * apu.deg), b=(np.zeros_like(lon) * apu.deg), frame='galactic')
coord_icrs = coord_gal.icrs
return (coord_icrs.ra.value, coord_icrs.dec.value)
|
def calculate_galactic_longitude_radec(lon):
'calculate_galactic_longitude_radec:\n \n Calculate the RA / Dec of a point in the plane of the galaxy.\n \n Args:\n lon (float) - galactic longitude\n \n Returns:\n (Ra,Dec)\n '
coord_gal = SkyCoord(l=(lon * apu.deg), b=(np.zeros_like(lon) * apu.deg), frame='galactic')
coord_icrs = coord_gal.icrs
return (coord_icrs.ra.value, coord_icrs.dec.value)<|docstring|>calculate_galactic_longitude_radec:
Calculate the RA / Dec of a point in the plane of the galaxy.
Args:
lon (float) - galactic longitude
Returns:
(Ra,Dec)<|endoftext|>
|
ed4dc49fe25c84f77b369986debcf999354b7de5ec1f354366333186cae17079
|
def calculate_galactic_longitude_altaz(lon, date_time_string):
"calculate_galactic_longitude_altaz:\n \n Calculate the Alt / Az of a point in the plane of the galaxy.\n \n Args:\n lon (float) - galactic longitude\n date_time_string (string) - A string specifying the date and time that \n takes the form: 'YYYY-MM-DD HH:MM:SS'\n \n Returns:\n (Ra,Dec)\n "
coord_gal = SkyCoord(l=(lon * apu.deg), b=(np.zeros_like(lon) * apu.deg), frame='galactic')
toronto_location = EarthLocation(lon=((360 - 79.3832) * apu.deg), lat=(43.6532 * apu.deg), height=(70 * apu.m))
utoffset = ((- 4) * apu.hour)
time = (Time(date_time_string) - utoffset)
coord_altaz = coord_gal.transform_to(AltAz(obstime=time, location=toronto_location))
return (coord_altaz.alt.value, coord_altaz.az.value)
|
calculate_galactic_longitude_altaz:
Calculate the Alt / Az of a point in the plane of the galaxy.
Args:
lon (float) - galactic longitude
date_time_string (string) - A string specifying the date and time that
takes the form: 'YYYY-MM-DD HH:MM:SS'
Returns:
(Ra,Dec)
|
src/ast2050/lab3.py
|
calculate_galactic_longitude_altaz
|
jamesmlane/AST2050-Labs
| 0 |
python
|
def calculate_galactic_longitude_altaz(lon, date_time_string):
"calculate_galactic_longitude_altaz:\n \n Calculate the Alt / Az of a point in the plane of the galaxy.\n \n Args:\n lon (float) - galactic longitude\n date_time_string (string) - A string specifying the date and time that \n takes the form: 'YYYY-MM-DD HH:MM:SS'\n \n Returns:\n (Ra,Dec)\n "
coord_gal = SkyCoord(l=(lon * apu.deg), b=(np.zeros_like(lon) * apu.deg), frame='galactic')
toronto_location = EarthLocation(lon=((360 - 79.3832) * apu.deg), lat=(43.6532 * apu.deg), height=(70 * apu.m))
utoffset = ((- 4) * apu.hour)
time = (Time(date_time_string) - utoffset)
coord_altaz = coord_gal.transform_to(AltAz(obstime=time, location=toronto_location))
return (coord_altaz.alt.value, coord_altaz.az.value)
|
def calculate_galactic_longitude_altaz(lon, date_time_string):
"calculate_galactic_longitude_altaz:\n \n Calculate the Alt / Az of a point in the plane of the galaxy.\n \n Args:\n lon (float) - galactic longitude\n date_time_string (string) - A string specifying the date and time that \n takes the form: 'YYYY-MM-DD HH:MM:SS'\n \n Returns:\n (Ra,Dec)\n "
coord_gal = SkyCoord(l=(lon * apu.deg), b=(np.zeros_like(lon) * apu.deg), frame='galactic')
toronto_location = EarthLocation(lon=((360 - 79.3832) * apu.deg), lat=(43.6532 * apu.deg), height=(70 * apu.m))
utoffset = ((- 4) * apu.hour)
time = (Time(date_time_string) - utoffset)
coord_altaz = coord_gal.transform_to(AltAz(obstime=time, location=toronto_location))
return (coord_altaz.alt.value, coord_altaz.az.value)<|docstring|>calculate_galactic_longitude_altaz:
Calculate the Alt / Az of a point in the plane of the galaxy.
Args:
lon (float) - galactic longitude
date_time_string (string) - A string specifying the date and time that
takes the form: 'YYYY-MM-DD HH:MM:SS'
Returns:
(Ra,Dec)<|endoftext|>
|
2140cab78022129eab8496614da2b31c1873786943146bdc136f2592072a5520
|
def calculate_power(data, chunk_size, sample_rate=5000000.0, lof=1420000000.0):
'calculate_power:\n \n Take the raw data time series from the airspy and compute the \n power spectrum\n \n Args:\n data (N-length int array)\n chunk_size (int) - The number of data points to calculate the FFT on \n at a time\n sample_rate (float) - samples/second [5E6]\n lof (float) - local oscillator frequency in Hz [1.42 Ghz]\n \n Return:\n power (float array) - Power\n freqs (float array) - RF Frequencies\n '
sample_size = len(data)
timestep = (1 / sample_rate)
fft = np.zeros(((chunk_size // 2) + 1), dtype='complex64')
for i in range((sample_size // chunk_size)):
fft += (np.fft.rfft(data[(i * chunk_size):((i + 1) * chunk_size)]) / (chunk_size / 2))
freq = (abs((lof - np.fft.rfftfreq(chunk_size, d=timestep))) + (sample_rate / 4))
power = (np.abs(fft) ** 2)
return (freq, power)
|
calculate_power:
Take the raw data time series from the airspy and compute the
power spectrum
Args:
data (N-length int array)
chunk_size (int) - The number of data points to calculate the FFT on
at a time
sample_rate (float) - samples/second [5E6]
lof (float) - local oscillator frequency in Hz [1.42 Ghz]
Return:
power (float array) - Power
freqs (float array) - RF Frequencies
|
src/ast2050/lab3.py
|
calculate_power
|
jamesmlane/AST2050-Labs
| 0 |
python
|
def calculate_power(data, chunk_size, sample_rate=5000000.0, lof=1420000000.0):
'calculate_power:\n \n Take the raw data time series from the airspy and compute the \n power spectrum\n \n Args:\n data (N-length int array)\n chunk_size (int) - The number of data points to calculate the FFT on \n at a time\n sample_rate (float) - samples/second [5E6]\n lof (float) - local oscillator frequency in Hz [1.42 Ghz]\n \n Return:\n power (float array) - Power\n freqs (float array) - RF Frequencies\n '
sample_size = len(data)
timestep = (1 / sample_rate)
fft = np.zeros(((chunk_size // 2) + 1), dtype='complex64')
for i in range((sample_size // chunk_size)):
fft += (np.fft.rfft(data[(i * chunk_size):((i + 1) * chunk_size)]) / (chunk_size / 2))
freq = (abs((lof - np.fft.rfftfreq(chunk_size, d=timestep))) + (sample_rate / 4))
power = (np.abs(fft) ** 2)
return (freq, power)
|
def calculate_power(data, chunk_size, sample_rate=5000000.0, lof=1420000000.0):
'calculate_power:\n \n Take the raw data time series from the airspy and compute the \n power spectrum\n \n Args:\n data (N-length int array)\n chunk_size (int) - The number of data points to calculate the FFT on \n at a time\n sample_rate (float) - samples/second [5E6]\n lof (float) - local oscillator frequency in Hz [1.42 Ghz]\n \n Return:\n power (float array) - Power\n freqs (float array) - RF Frequencies\n '
sample_size = len(data)
timestep = (1 / sample_rate)
fft = np.zeros(((chunk_size // 2) + 1), dtype='complex64')
for i in range((sample_size // chunk_size)):
fft += (np.fft.rfft(data[(i * chunk_size):((i + 1) * chunk_size)]) / (chunk_size / 2))
freq = (abs((lof - np.fft.rfftfreq(chunk_size, d=timestep))) + (sample_rate / 4))
power = (np.abs(fft) ** 2)
return (freq, power)<|docstring|>calculate_power:
Take the raw data time series from the airspy and compute the
power spectrum
Args:
data (N-length int array)
chunk_size (int) - The number of data points to calculate the FFT on
at a time
sample_rate (float) - samples/second [5E6]
lof (float) - local oscillator frequency in Hz [1.42 Ghz]
Return:
power (float array) - Power
freqs (float array) - RF Frequencies<|endoftext|>
|
e325a16aec85791787e9ae484dcbae893e6adc2b5cc1402064db388fb6de5731
|
def GetMetadata(source, args=None):
"Convenience function to obtain the correct subclass of ``Metadata``.\n Accepts either a ``list[str]`` where every element ends with '.flac' and\n refers to a file, or a ``str`` which ends in '.cue' and refers to a file.\n Another valid input is an object of a class derived from ``Metadata``.\n "
if issubclass(source.__class__, Metadata):
return source
if (args is None):
args = arguments.ParseArguments()
if (isinstance(source, str) and source.lower().endswith(ext.CUE) and os.path.isfile(source)):
return CueMetadata(source, args)
if isinstance(source, list):
if any((((not os.path.isfile(f)) or (not f.lower().endswith(ext.FLAC))) for f in source)):
raise ValueError('List input supported but must be list of FLAC file name')
cls = (MultidiscMetadata if args.multidisc else AlbumMetadata)
return cls(source, args)
raise TypeError('Only supported inputs are Metadata objects, list of FLAC file names, or .CUE filename')
|
Convenience function to obtain the correct subclass of ``Metadata``.
Accepts either a ``list[str]`` where every element ends with '.flac' and
refers to a file, or a ``str`` which ends in '.cue' and refers to a file.
Another valid input is an object of a class derived from ``Metadata``.
|
flac_to_mka/flac/metadata.py
|
GetMetadata
|
lbianch/flac_to_mka
| 0 |
python
|
def GetMetadata(source, args=None):
"Convenience function to obtain the correct subclass of ``Metadata``.\n Accepts either a ``list[str]`` where every element ends with '.flac' and\n refers to a file, or a ``str`` which ends in '.cue' and refers to a file.\n Another valid input is an object of a class derived from ``Metadata``.\n "
if issubclass(source.__class__, Metadata):
return source
if (args is None):
args = arguments.ParseArguments()
if (isinstance(source, str) and source.lower().endswith(ext.CUE) and os.path.isfile(source)):
return CueMetadata(source, args)
if isinstance(source, list):
if any((((not os.path.isfile(f)) or (not f.lower().endswith(ext.FLAC))) for f in source)):
raise ValueError('List input supported but must be list of FLAC file name')
cls = (MultidiscMetadata if args.multidisc else AlbumMetadata)
return cls(source, args)
raise TypeError('Only supported inputs are Metadata objects, list of FLAC file names, or .CUE filename')
|
def GetMetadata(source, args=None):
"Convenience function to obtain the correct subclass of ``Metadata``.\n Accepts either a ``list[str]`` where every element ends with '.flac' and\n refers to a file, or a ``str`` which ends in '.cue' and refers to a file.\n Another valid input is an object of a class derived from ``Metadata``.\n "
if issubclass(source.__class__, Metadata):
return source
if (args is None):
args = arguments.ParseArguments()
if (isinstance(source, str) and source.lower().endswith(ext.CUE) and os.path.isfile(source)):
return CueMetadata(source, args)
if isinstance(source, list):
if any((((not os.path.isfile(f)) or (not f.lower().endswith(ext.FLAC))) for f in source)):
raise ValueError('List input supported but must be list of FLAC file name')
cls = (MultidiscMetadata if args.multidisc else AlbumMetadata)
return cls(source, args)
raise TypeError('Only supported inputs are Metadata objects, list of FLAC file names, or .CUE filename')<|docstring|>Convenience function to obtain the correct subclass of ``Metadata``.
Accepts either a ``list[str]`` where every element ends with '.flac' and
refers to a file, or a ``str`` which ends in '.cue' and refers to a file.
Another valid input is an object of a class derived from ``Metadata``.<|endoftext|>
|
bd86667d48de9e5732a1abb4f005a0ad6022c5219bd46f5f300efc7f02eed6c9
|
def _MergeWithArgs(self, args):
'Method to introduce arguments passed in via command line. These\n arguments take priority over any other extracted information.\n '
if (not args):
self._Validate()
return
if args.album:
self['TITLE'] = args.album
if args.artist:
self['ARTIST'] = args.artist
if args.genre:
self['GENRE'] = args.genre
if args.year:
self['DATE_RECORDED'] = args.year
if args.label:
self['LABEL'] = args.label
if (args.issuedate and ('LABEL' in self)):
self['ISSUE_DATE'] = args.issuedate
if args.version:
self['VERSION'] = args.version
if args.medium:
self['ORIGINAL_MEDIUM'] = args.medium
if (args.disc and (self.discs > 1)):
self['PART_NUMBER'] = args.disc
if (args.discs and ('PART_NUMBER' in self)):
self.discs = int(args.discs)
if (args.disc and args.discs):
self['PART_NUMBER'] = args.disc
self.discs = int(args.discs)
if args.nodiscs:
self.discs = 1
with IgnoreKeyError:
del self['PART_NUMBER']
self._Validate()
|
Method to introduce arguments passed in via command line. These
arguments take priority over any other extracted information.
|
flac_to_mka/flac/metadata.py
|
_MergeWithArgs
|
lbianch/flac_to_mka
| 0 |
python
|
def _MergeWithArgs(self, args):
'Method to introduce arguments passed in via command line. These\n arguments take priority over any other extracted information.\n '
if (not args):
self._Validate()
return
if args.album:
self['TITLE'] = args.album
if args.artist:
self['ARTIST'] = args.artist
if args.genre:
self['GENRE'] = args.genre
if args.year:
self['DATE_RECORDED'] = args.year
if args.label:
self['LABEL'] = args.label
if (args.issuedate and ('LABEL' in self)):
self['ISSUE_DATE'] = args.issuedate
if args.version:
self['VERSION'] = args.version
if args.medium:
self['ORIGINAL_MEDIUM'] = args.medium
if (args.disc and (self.discs > 1)):
self['PART_NUMBER'] = args.disc
if (args.discs and ('PART_NUMBER' in self)):
self.discs = int(args.discs)
if (args.disc and args.discs):
self['PART_NUMBER'] = args.disc
self.discs = int(args.discs)
if args.nodiscs:
self.discs = 1
with IgnoreKeyError:
del self['PART_NUMBER']
self._Validate()
|
def _MergeWithArgs(self, args):
'Method to introduce arguments passed in via command line. These\n arguments take priority over any other extracted information.\n '
if (not args):
self._Validate()
return
if args.album:
self['TITLE'] = args.album
if args.artist:
self['ARTIST'] = args.artist
if args.genre:
self['GENRE'] = args.genre
if args.year:
self['DATE_RECORDED'] = args.year
if args.label:
self['LABEL'] = args.label
if (args.issuedate and ('LABEL' in self)):
self['ISSUE_DATE'] = args.issuedate
if args.version:
self['VERSION'] = args.version
if args.medium:
self['ORIGINAL_MEDIUM'] = args.medium
if (args.disc and (self.discs > 1)):
self['PART_NUMBER'] = args.disc
if (args.discs and ('PART_NUMBER' in self)):
self.discs = int(args.discs)
if (args.disc and args.discs):
self['PART_NUMBER'] = args.disc
self.discs = int(args.discs)
if args.nodiscs:
self.discs = 1
with IgnoreKeyError:
del self['PART_NUMBER']
self._Validate()<|docstring|>Method to introduce arguments passed in via command line. These
arguments take priority over any other extracted information.<|endoftext|>
|
ef60b5850f6b9749883ab831a22f6f2c7bc859ec71287717725a611c5588f3a5
|
def _Validate(self):
'Ensures sane entries for "ISSUE_DATE" and "LABEL", disc numbering,\n and ensures that the required tags ("TITLE", "ARTIST", "GENRE", "DATE")\n have been set. Removes leading or trailing whitespace for all tags.\n '
if (('ISSUE_DATE' in self) != ('LABEL' in self)):
with IgnoreKeyError:
del self['ISSUE_DATE']
with IgnoreKeyError:
del self['LABEL']
if ((self.discs > 1) and ('PART_NUMBER' not in self)):
raise DiscConfigurationError('Number of discs is set but disc number not known')
if (('PART_NUMBER' in self) and (self.discs < 2)):
raise DiscConfigurationError('Disc number is set but number of discs is not known')
if ('ORIGINAL_MEDIUM' not in self):
self['ORIGINAL_MEDIUM'] = 'CD'
elif (self['ORIGINAL_MEDIUM'] not in arguments.MEDIUM_CHOICES):
logging.critical("Invalid medium: '%s' - must be one of %s", self['ORIGINAL_MEDIUM'], arguments.MEDIUM_CHOICES)
raise ValueError(f"Invalid medium: '{self['ORIGINAL_MEDIUM']}' - must be one of {arguments.MEDIUM_CHOICES}")
required_tags = {'TITLE': 'title', 'ARTIST': 'artist', 'GENRE': 'genre', 'DATE_RECORDED': 'year'}
for tag in required_tags:
if (self[tag] is None):
raise TagNotFoundError(f'Incomplete metadata - missing {required_tags[tag]}')
for (key, value) in self.items():
self[key] = value.strip()
|
Ensures sane entries for "ISSUE_DATE" and "LABEL", disc numbering,
and ensures that the required tags ("TITLE", "ARTIST", "GENRE", "DATE")
have been set. Removes leading or trailing whitespace for all tags.
|
flac_to_mka/flac/metadata.py
|
_Validate
|
lbianch/flac_to_mka
| 0 |
python
|
def _Validate(self):
'Ensures sane entries for "ISSUE_DATE" and "LABEL", disc numbering,\n and ensures that the required tags ("TITLE", "ARTIST", "GENRE", "DATE")\n have been set. Removes leading or trailing whitespace for all tags.\n '
if (('ISSUE_DATE' in self) != ('LABEL' in self)):
with IgnoreKeyError:
del self['ISSUE_DATE']
with IgnoreKeyError:
del self['LABEL']
if ((self.discs > 1) and ('PART_NUMBER' not in self)):
raise DiscConfigurationError('Number of discs is set but disc number not known')
if (('PART_NUMBER' in self) and (self.discs < 2)):
raise DiscConfigurationError('Disc number is set but number of discs is not known')
if ('ORIGINAL_MEDIUM' not in self):
self['ORIGINAL_MEDIUM'] = 'CD'
elif (self['ORIGINAL_MEDIUM'] not in arguments.MEDIUM_CHOICES):
logging.critical("Invalid medium: '%s' - must be one of %s", self['ORIGINAL_MEDIUM'], arguments.MEDIUM_CHOICES)
raise ValueError(f"Invalid medium: '{self['ORIGINAL_MEDIUM']}' - must be one of {arguments.MEDIUM_CHOICES}")
required_tags = {'TITLE': 'title', 'ARTIST': 'artist', 'GENRE': 'genre', 'DATE_RECORDED': 'year'}
for tag in required_tags:
if (self[tag] is None):
raise TagNotFoundError(f'Incomplete metadata - missing {required_tags[tag]}')
for (key, value) in self.items():
self[key] = value.strip()
|
def _Validate(self):
'Ensures sane entries for "ISSUE_DATE" and "LABEL", disc numbering,\n and ensures that the required tags ("TITLE", "ARTIST", "GENRE", "DATE")\n have been set. Removes leading or trailing whitespace for all tags.\n '
if (('ISSUE_DATE' in self) != ('LABEL' in self)):
with IgnoreKeyError:
del self['ISSUE_DATE']
with IgnoreKeyError:
del self['LABEL']
if ((self.discs > 1) and ('PART_NUMBER' not in self)):
raise DiscConfigurationError('Number of discs is set but disc number not known')
if (('PART_NUMBER' in self) and (self.discs < 2)):
raise DiscConfigurationError('Disc number is set but number of discs is not known')
if ('ORIGINAL_MEDIUM' not in self):
self['ORIGINAL_MEDIUM'] = 'CD'
elif (self['ORIGINAL_MEDIUM'] not in arguments.MEDIUM_CHOICES):
logging.critical("Invalid medium: '%s' - must be one of %s", self['ORIGINAL_MEDIUM'], arguments.MEDIUM_CHOICES)
raise ValueError(f"Invalid medium: '{self['ORIGINAL_MEDIUM']}' - must be one of {arguments.MEDIUM_CHOICES}")
required_tags = {'TITLE': 'title', 'ARTIST': 'artist', 'GENRE': 'genre', 'DATE_RECORDED': 'year'}
for tag in required_tags:
if (self[tag] is None):
raise TagNotFoundError(f'Incomplete metadata - missing {required_tags[tag]}')
for (key, value) in self.items():
self[key] = value.strip()<|docstring|>Ensures sane entries for "ISSUE_DATE" and "LABEL", disc numbering,
and ensures that the required tags ("TITLE", "ARTIST", "GENRE", "DATE")
have been set. Removes leading or trailing whitespace for all tags.<|endoftext|>
|
6e3ff4d3a42e46f37eba48c0ab2edea0a412bcdc0a3f69e4d322adce9b3564f3
|
def _Finalize(self):
'``self.sumparts`` is a ``property`` returning a boolean which controls whether\n the output should contain the "TOTAL_PARTS" field which specifies the number of\n tracks. This method also ensures the "DATE_RECORDED" field is a 4-digit year.\n Note that when specified, the number of tracks is not simply ``len(self.tracks)``\n but rather the highest numbered track. Ensures that if any track has a phase, but\n the phase name is not set then it defaults to \'Phase\'.\n '
logging.debug('Sumparts = %s', self.sumparts)
if self.sumparts:
logging.debug('Summing parts')
self['TOTAL_PARTS'] = str(max((int(x['track']) for x in self.tracks)))
elif ('TOTAL_PARTS' in self):
logging.debug("Deleting 'TOTAL_PARTS'")
del self['TOTAL_PARTS']
else:
logging.debug("Not summing parts and 'TOTAL_PARTS' doesn't exist")
if (len(self['DATE_RECORDED']) != 4):
logging.debug('Improper date found %s', self['DATE_RECORDED'])
year = re.split('-|/|\\.', self['DATE_RECORDED'])
for y in year:
if (len(y) == 4):
logging.debug('Found year %s', y)
self['DATE_RECORDED'] = y
break
else:
raise RuntimeError(f"Can't parse date {self['DATE_RECORDED']}")
if (any((('phase' in t) for t in self.tracks)) and ('PHASE_NAME' not in self.data)):
self.data['PHASE_NAME'] = 'Phase'
|
``self.sumparts`` is a ``property`` returning a boolean which controls whether
the output should contain the "TOTAL_PARTS" field which specifies the number of
tracks. This method also ensures the "DATE_RECORDED" field is a 4-digit year.
Note that when specified, the number of tracks is not simply ``len(self.tracks)``
but rather the highest numbered track. Ensures that if any track has a phase, but
the phase name is not set then it defaults to 'Phase'.
|
flac_to_mka/flac/metadata.py
|
_Finalize
|
lbianch/flac_to_mka
| 0 |
python
|
def _Finalize(self):
'``self.sumparts`` is a ``property`` returning a boolean which controls whether\n the output should contain the "TOTAL_PARTS" field which specifies the number of\n tracks. This method also ensures the "DATE_RECORDED" field is a 4-digit year.\n Note that when specified, the number of tracks is not simply ``len(self.tracks)``\n but rather the highest numbered track. Ensures that if any track has a phase, but\n the phase name is not set then it defaults to \'Phase\'.\n '
logging.debug('Sumparts = %s', self.sumparts)
if self.sumparts:
logging.debug('Summing parts')
self['TOTAL_PARTS'] = str(max((int(x['track']) for x in self.tracks)))
elif ('TOTAL_PARTS' in self):
logging.debug("Deleting 'TOTAL_PARTS'")
del self['TOTAL_PARTS']
else:
logging.debug("Not summing parts and 'TOTAL_PARTS' doesn't exist")
if (len(self['DATE_RECORDED']) != 4):
logging.debug('Improper date found %s', self['DATE_RECORDED'])
year = re.split('-|/|\\.', self['DATE_RECORDED'])
for y in year:
if (len(y) == 4):
logging.debug('Found year %s', y)
self['DATE_RECORDED'] = y
break
else:
raise RuntimeError(f"Can't parse date {self['DATE_RECORDED']}")
if (any((('phase' in t) for t in self.tracks)) and ('PHASE_NAME' not in self.data)):
self.data['PHASE_NAME'] = 'Phase'
|
def _Finalize(self):
'``self.sumparts`` is a ``property`` returning a boolean which controls whether\n the output should contain the "TOTAL_PARTS" field which specifies the number of\n tracks. This method also ensures the "DATE_RECORDED" field is a 4-digit year.\n Note that when specified, the number of tracks is not simply ``len(self.tracks)``\n but rather the highest numbered track. Ensures that if any track has a phase, but\n the phase name is not set then it defaults to \'Phase\'.\n '
logging.debug('Sumparts = %s', self.sumparts)
if self.sumparts:
logging.debug('Summing parts')
self['TOTAL_PARTS'] = str(max((int(x['track']) for x in self.tracks)))
elif ('TOTAL_PARTS' in self):
logging.debug("Deleting 'TOTAL_PARTS'")
del self['TOTAL_PARTS']
else:
logging.debug("Not summing parts and 'TOTAL_PARTS' doesn't exist")
if (len(self['DATE_RECORDED']) != 4):
logging.debug('Improper date found %s', self['DATE_RECORDED'])
year = re.split('-|/|\\.', self['DATE_RECORDED'])
for y in year:
if (len(y) == 4):
logging.debug('Found year %s', y)
self['DATE_RECORDED'] = y
break
else:
raise RuntimeError(f"Can't parse date {self['DATE_RECORDED']}")
if (any((('phase' in t) for t in self.tracks)) and ('PHASE_NAME' not in self.data)):
self.data['PHASE_NAME'] = 'Phase'<|docstring|>``self.sumparts`` is a ``property`` returning a boolean which controls whether
the output should contain the "TOTAL_PARTS" field which specifies the number of
tracks. This method also ensures the "DATE_RECORDED" field is a 4-digit year.
Note that when specified, the number of tracks is not simply ``len(self.tracks)``
but rather the highest numbered track. Ensures that if any track has a phase, but
the phase name is not set then it defaults to 'Phase'.<|endoftext|>
|
b495defc31f18bf5ea7d01209a7595e37b7a3e7c2964768f96e091dffbca8b54
|
def __getitem__(self, key):
'If the ``key`` doesn\'t exist, the empty string is returned.\n As though ``__getitem__(key)`` was really ``get(key, "")``.\n NB: Don\'t want to use a ``defaultdict`` for ``self.data`` since\n that would actually store new keys when they\'re accessed.\n '
return self.data.get(key, '')
|
If the ``key`` doesn't exist, the empty string is returned.
As though ``__getitem__(key)`` was really ``get(key, "")``.
NB: Don't want to use a ``defaultdict`` for ``self.data`` since
that would actually store new keys when they're accessed.
|
flac_to_mka/flac/metadata.py
|
__getitem__
|
lbianch/flac_to_mka
| 0 |
python
|
def __getitem__(self, key):
'If the ``key`` doesn\'t exist, the empty string is returned.\n As though ``__getitem__(key)`` was really ``get(key, )``.\n NB: Don\'t want to use a ``defaultdict`` for ``self.data`` since\n that would actually store new keys when they\'re accessed.\n '
return self.data.get(key, )
|
def __getitem__(self, key):
'If the ``key`` doesn\'t exist, the empty string is returned.\n As though ``__getitem__(key)`` was really ``get(key, )``.\n NB: Don\'t want to use a ``defaultdict`` for ``self.data`` since\n that would actually store new keys when they\'re accessed.\n '
return self.data.get(key, )<|docstring|>If the ``key`` doesn't exist, the empty string is returned.
As though ``__getitem__(key)`` was really ``get(key, "")``.
NB: Don't want to use a ``defaultdict`` for ``self.data`` since
that would actually store new keys when they're accessed.<|endoftext|>
|
337ec47b5175713129b0cdf0fbeb6d15f0f7f58255f71d5def2d573acadccc09
|
def __str__(self):
'String representation of the disc-level metadata. Produces a\n table with the metadata which can be printed. Note that track-level\n information is not part of the table.\n '
s = [('Album Title', self['TITLE']), ('Album Artist', self['ARTIST']), ('Year', self['DATE_RECORDED']), ('Genre', self['GENRE'])]
s = OrderedDict(s)
def add_optional(key):
nonlocal s
if (key in self):
text = key.replace('_', ' ').split(' ')
text = ' '.join([x.capitalize() for x in text])
s[text] = self[key]
add_optional('LABEL')
add_optional('ISSUE_DATE')
add_optional('ORIGINAL_MEDIUM')
add_optional('VERSION')
add_optional('HD_FORMAT')
add_optional('DISC_NAME')
add_optional('PHASE_NAME')
if (self.discs > 1):
s['Disc'] = self['PART_NUMBER']
s['Discs'] = self.discs
if (self.channels != '2.0'):
s['Channels'] = self.channels
max_len = (max((len(x[0]) for x in s)) + 1)
def line(k, v):
return f"{k.ljust(max_len, '.')}: {v}"
s = [line(*x) for x in s.items()]
max_len = max((len(x) for x in s))
s = [f'= {x:{max_len}} =' for x in s]
max_len += 4
s = (([' ALBUM INFORMATION '.center(max_len, '=')] + s) + [('=' * max_len)])
return '\n'.join(s)
|
String representation of the disc-level metadata. Produces a
table with the metadata which can be printed. Note that track-level
information is not part of the table.
|
flac_to_mka/flac/metadata.py
|
__str__
|
lbianch/flac_to_mka
| 0 |
python
|
def __str__(self):
'String representation of the disc-level metadata. Produces a\n table with the metadata which can be printed. Note that track-level\n information is not part of the table.\n '
s = [('Album Title', self['TITLE']), ('Album Artist', self['ARTIST']), ('Year', self['DATE_RECORDED']), ('Genre', self['GENRE'])]
s = OrderedDict(s)
def add_optional(key):
nonlocal s
if (key in self):
text = key.replace('_', ' ').split(' ')
text = ' '.join([x.capitalize() for x in text])
s[text] = self[key]
add_optional('LABEL')
add_optional('ISSUE_DATE')
add_optional('ORIGINAL_MEDIUM')
add_optional('VERSION')
add_optional('HD_FORMAT')
add_optional('DISC_NAME')
add_optional('PHASE_NAME')
if (self.discs > 1):
s['Disc'] = self['PART_NUMBER']
s['Discs'] = self.discs
if (self.channels != '2.0'):
s['Channels'] = self.channels
max_len = (max((len(x[0]) for x in s)) + 1)
def line(k, v):
return f"{k.ljust(max_len, '.')}: {v}"
s = [line(*x) for x in s.items()]
max_len = max((len(x) for x in s))
s = [f'= {x:{max_len}} =' for x in s]
max_len += 4
s = (([' ALBUM INFORMATION '.center(max_len, '=')] + s) + [('=' * max_len)])
return '\n'.join(s)
|
def __str__(self):
'String representation of the disc-level metadata. Produces a\n table with the metadata which can be printed. Note that track-level\n information is not part of the table.\n '
s = [('Album Title', self['TITLE']), ('Album Artist', self['ARTIST']), ('Year', self['DATE_RECORDED']), ('Genre', self['GENRE'])]
s = OrderedDict(s)
def add_optional(key):
nonlocal s
if (key in self):
text = key.replace('_', ' ').split(' ')
text = ' '.join([x.capitalize() for x in text])
s[text] = self[key]
add_optional('LABEL')
add_optional('ISSUE_DATE')
add_optional('ORIGINAL_MEDIUM')
add_optional('VERSION')
add_optional('HD_FORMAT')
add_optional('DISC_NAME')
add_optional('PHASE_NAME')
if (self.discs > 1):
s['Disc'] = self['PART_NUMBER']
s['Discs'] = self.discs
if (self.channels != '2.0'):
s['Channels'] = self.channels
max_len = (max((len(x[0]) for x in s)) + 1)
def line(k, v):
return f"{k.ljust(max_len, '.')}: {v}"
s = [line(*x) for x in s.items()]
max_len = max((len(x) for x in s))
s = [f'= {x:{max_len}} =' for x in s]
max_len += 4
s = (([' ALBUM INFORMATION '.center(max_len, '=')] + s) + [('=' * max_len)])
return '\n'.join(s)<|docstring|>String representation of the disc-level metadata. Produces a
table with the metadata which can be printed. Note that track-level
information is not part of the table.<|endoftext|>
|
f2a7dd366f20ade559dd62c06318af74a0dec77668b63424ea7023d2c47d2549
|
def GetOutputFilename(self, directory=None):
'If an explicit filename was provided to command line arguments,\n and ``_MergeWithArgs`` was called, typically via a subclass\n constructor,then that filename is returned.\n Otherwise a name of the form\n Artist - Date - Title (Version) (Disc Disc#) DiscName (Label IssueDate Medium Channels).wav\n is generated, where the parentheses are included only if any\n part inside is non-empty. The Medium is blank if it is "CD".\n Channels is not filled in if it is "2.0". Invalid filename\n characters are removed or replaced with dashes.\n '
if self.forced_filename:
logging.debug('Forced filename or pre-computed file name = %s', self.filename)
return self.filename
tags = dict()
tags['base'] = f"{self['ARTIST']} - {self['DATE_RECORDED']} - {self['TITLE']}"
tags['version'] = (f" ({self['VERSION']})" if self['VERSION'] else '')
channels = (self.channels if (self.channels != '2.0') else '')
if (self['ORIGINAL_MEDIUM'] == 'CD'):
labeltag = f"{self['LABEL']} {self['ISSUE_DATE']} {channels}"
else:
labeltag = f"{self['LABEL']} {self['ISSUE_DATE']} {self['ORIGINAL_MEDIUM']} {channels}"
labeltag = labeltag.strip()
tags['label'] = (labeltag and f' ({labeltag})')
if self['PART_NUMBER']:
disctag = f" (Disc {self['PART_NUMBER']}) {self['DISC_NAME']}"
else:
disctag = f" {self['DISC_NAME']}"
tags['disc'] = disctag.rstrip()
filename = f"{tags['base']}{tags['version']}{tags['disc']}{tags['label']}{ext.WAV}"
filename = re.compile('[<>:/\\\\]').sub('-', filename)
filename = re.compile('[|?*]').sub('', filename)
filename = filename.replace('"', "'")
if directory:
return os.path.join(directory, filename)
return filename
|
If an explicit filename was provided to command line arguments,
and ``_MergeWithArgs`` was called, typically via a subclass
constructor,then that filename is returned.
Otherwise a name of the form
Artist - Date - Title (Version) (Disc Disc#) DiscName (Label IssueDate Medium Channels).wav
is generated, where the parentheses are included only if any
part inside is non-empty. The Medium is blank if it is "CD".
Channels is not filled in if it is "2.0". Invalid filename
characters are removed or replaced with dashes.
|
flac_to_mka/flac/metadata.py
|
GetOutputFilename
|
lbianch/flac_to_mka
| 0 |
python
|
def GetOutputFilename(self, directory=None):
'If an explicit filename was provided to command line arguments,\n and ``_MergeWithArgs`` was called, typically via a subclass\n constructor,then that filename is returned.\n Otherwise a name of the form\n Artist - Date - Title (Version) (Disc Disc#) DiscName (Label IssueDate Medium Channels).wav\n is generated, where the parentheses are included only if any\n part inside is non-empty. The Medium is blank if it is "CD".\n Channels is not filled in if it is "2.0". Invalid filename\n characters are removed or replaced with dashes.\n '
if self.forced_filename:
logging.debug('Forced filename or pre-computed file name = %s', self.filename)
return self.filename
tags = dict()
tags['base'] = f"{self['ARTIST']} - {self['DATE_RECORDED']} - {self['TITLE']}"
tags['version'] = (f" ({self['VERSION']})" if self['VERSION'] else )
channels = (self.channels if (self.channels != '2.0') else )
if (self['ORIGINAL_MEDIUM'] == 'CD'):
labeltag = f"{self['LABEL']} {self['ISSUE_DATE']} {channels}"
else:
labeltag = f"{self['LABEL']} {self['ISSUE_DATE']} {self['ORIGINAL_MEDIUM']} {channels}"
labeltag = labeltag.strip()
tags['label'] = (labeltag and f' ({labeltag})')
if self['PART_NUMBER']:
disctag = f" (Disc {self['PART_NUMBER']}) {self['DISC_NAME']}"
else:
disctag = f" {self['DISC_NAME']}"
tags['disc'] = disctag.rstrip()
filename = f"{tags['base']}{tags['version']}{tags['disc']}{tags['label']}{ext.WAV}"
filename = re.compile('[<>:/\\\\]').sub('-', filename)
filename = re.compile('[|?*]').sub(, filename)
filename = filename.replace('"', "'")
if directory:
return os.path.join(directory, filename)
return filename
|
def GetOutputFilename(self, directory=None):
'If an explicit filename was provided to command line arguments,\n and ``_MergeWithArgs`` was called, typically via a subclass\n constructor,then that filename is returned.\n Otherwise a name of the form\n Artist - Date - Title (Version) (Disc Disc#) DiscName (Label IssueDate Medium Channels).wav\n is generated, where the parentheses are included only if any\n part inside is non-empty. The Medium is blank if it is "CD".\n Channels is not filled in if it is "2.0". Invalid filename\n characters are removed or replaced with dashes.\n '
if self.forced_filename:
logging.debug('Forced filename or pre-computed file name = %s', self.filename)
return self.filename
tags = dict()
tags['base'] = f"{self['ARTIST']} - {self['DATE_RECORDED']} - {self['TITLE']}"
tags['version'] = (f" ({self['VERSION']})" if self['VERSION'] else )
channels = (self.channels if (self.channels != '2.0') else )
if (self['ORIGINAL_MEDIUM'] == 'CD'):
labeltag = f"{self['LABEL']} {self['ISSUE_DATE']} {channels}"
else:
labeltag = f"{self['LABEL']} {self['ISSUE_DATE']} {self['ORIGINAL_MEDIUM']} {channels}"
labeltag = labeltag.strip()
tags['label'] = (labeltag and f' ({labeltag})')
if self['PART_NUMBER']:
disctag = f" (Disc {self['PART_NUMBER']}) {self['DISC_NAME']}"
else:
disctag = f" {self['DISC_NAME']}"
tags['disc'] = disctag.rstrip()
filename = f"{tags['base']}{tags['version']}{tags['disc']}{tags['label']}{ext.WAV}"
filename = re.compile('[<>:/\\\\]').sub('-', filename)
filename = re.compile('[|?*]').sub(, filename)
filename = filename.replace('"', "'")
if directory:
return os.path.join(directory, filename)
return filename<|docstring|>If an explicit filename was provided to command line arguments,
and ``_MergeWithArgs`` was called, typically via a subclass
constructor,then that filename is returned.
Otherwise a name of the form
Artist - Date - Title (Version) (Disc Disc#) DiscName (Label IssueDate Medium Channels).wav
is generated, where the parentheses are included only if any
part inside is non-empty. The Medium is blank if it is "CD".
Channels is not filled in if it is "2.0". Invalid filename
characters are removed or replaced with dashes.<|endoftext|>
|
f0295bcce89989c7216f6152e0302976ddf2c16a15d97a275a8c9f0b66f57771
|
def PrintMetadata(self):
'Formats and prints the metadata using the string\n representation and adding in track-level details.\n '
def PrintTrack(trackno, track):
output = [f'File {str((trackno + 1)).zfill(2)}:']
with IgnoreKeyError:
output.append(f"Disc {track['disc']}")
with IgnoreKeyError:
output.append(f"Side {track['side']}")
output.append(f"Track {track['track'].ljust(2)}")
with IgnoreKeyError:
output.append(f"Phase {track['phase']}")
with IgnoreKeyError:
output.append(f"Subindex {track['subindex']}")
output.append(f"Time {track['start_time']}")
output.append(f""""{track['title']}"""")
with IgnoreKeyError:
output[(- 1)] = f"""{output[(- 1)][:(- 1)]}: {track['subtitle']}""""
print(' '.join(output))
print(self)
for (trackno, track) in enumerate(self.tracks):
PrintTrack(trackno, track)
filename = self.GetOutputFilename().replace(ext.WAV, ext.MKA)
print('Filename:', filename)
|
Formats and prints the metadata using the string
representation and adding in track-level details.
|
flac_to_mka/flac/metadata.py
|
PrintMetadata
|
lbianch/flac_to_mka
| 0 |
python
|
def PrintMetadata(self):
'Formats and prints the metadata using the string\n representation and adding in track-level details.\n '
def PrintTrack(trackno, track):
output = [f'File {str((trackno + 1)).zfill(2)}:']
with IgnoreKeyError:
output.append(f"Disc {track['disc']}")
with IgnoreKeyError:
output.append(f"Side {track['side']}")
output.append(f"Track {track['track'].ljust(2)}")
with IgnoreKeyError:
output.append(f"Phase {track['phase']}")
with IgnoreKeyError:
output.append(f"Subindex {track['subindex']}")
output.append(f"Time {track['start_time']}")
output.append(f{track['title']})
with IgnoreKeyError:
output[(- 1)] = f"{output[(- 1)][:(- 1)]}: {track['subtitle']}
print(' '.join(output))
print(self)
for (trackno, track) in enumerate(self.tracks):
PrintTrack(trackno, track)
filename = self.GetOutputFilename().replace(ext.WAV, ext.MKA)
print('Filename:', filename)
|
def PrintMetadata(self):
'Formats and prints the metadata using the string\n representation and adding in track-level details.\n '
def PrintTrack(trackno, track):
output = [f'File {str((trackno + 1)).zfill(2)}:']
with IgnoreKeyError:
output.append(f"Disc {track['disc']}")
with IgnoreKeyError:
output.append(f"Side {track['side']}")
output.append(f"Track {track['track'].ljust(2)}")
with IgnoreKeyError:
output.append(f"Phase {track['phase']}")
with IgnoreKeyError:
output.append(f"Subindex {track['subindex']}")
output.append(f"Time {track['start_time']}")
output.append(f{track['title']})
with IgnoreKeyError:
output[(- 1)] = f"{output[(- 1)][:(- 1)]}: {track['subtitle']}
print(' '.join(output))
print(self)
for (trackno, track) in enumerate(self.tracks):
PrintTrack(trackno, track)
filename = self.GetOutputFilename().replace(ext.WAV, ext.MKA)
print('Filename:', filename)<|docstring|>Formats and prints the metadata using the string
representation and adding in track-level details.<|endoftext|>
|
db43d65600aa09e50cee4a2dcf98e53c273a06bde8712e6b8ced199cc10003f9
|
def Confirm(self):
'Prints out metadata using ``PrintMetadata`` then asks\n the user if they want to continue. Any answer starting\n with \'n\' or \'N\' is interpreted as "no" while any other\n answer is interpreted as "yes".\n Returns:\n bool: True for user-approved merging, False for cancel\n '
self.PrintMetadata()
answer = input('Continue [Y/n]? ').lower()
return (not answer.startswith('n'))
|
Prints out metadata using ``PrintMetadata`` then asks
the user if they want to continue. Any answer starting
with 'n' or 'N' is interpreted as "no" while any other
answer is interpreted as "yes".
Returns:
bool: True for user-approved merging, False for cancel
|
flac_to_mka/flac/metadata.py
|
Confirm
|
lbianch/flac_to_mka
| 0 |
python
|
def Confirm(self):
'Prints out metadata using ``PrintMetadata`` then asks\n the user if they want to continue. Any answer starting\n with \'n\' or \'N\' is interpreted as "no" while any other\n answer is interpreted as "yes".\n Returns:\n bool: True for user-approved merging, False for cancel\n '
self.PrintMetadata()
answer = input('Continue [Y/n]? ').lower()
return (not answer.startswith('n'))
|
def Confirm(self):
'Prints out metadata using ``PrintMetadata`` then asks\n the user if they want to continue. Any answer starting\n with \'n\' or \'N\' is interpreted as "no" while any other\n answer is interpreted as "yes".\n Returns:\n bool: True for user-approved merging, False for cancel\n '
self.PrintMetadata()
answer = input('Continue [Y/n]? ').lower()
return (not answer.startswith('n'))<|docstring|>Prints out metadata using ``PrintMetadata`` then asks
the user if they want to continue. Any answer starting
with 'n' or 'N' is interpreted as "no" while any other
answer is interpreted as "yes".
Returns:
bool: True for user-approved merging, False for cancel<|endoftext|>
|
b5d04158f94e2f6863eb9f43b6da1b4a43a0b7c8a4b9d75265af21f6d4e3add5
|
@staticmethod
def ExtractProperty(line, name):
'Helper method to deal with lines in a CUE sheet which\n have the form:\n name "value"\n where ``name`` may have whitespace inside it, before it, and\n the quote marks are optional with possible whitespace at the\n end of the line. The return value would be ``value``.\n\n Expects ``str`` input and output.'
line = line.replace('"', '')
line = line.replace(name, '')
return line.strip()
|
Helper method to deal with lines in a CUE sheet which
have the form:
name "value"
where ``name`` may have whitespace inside it, before it, and
the quote marks are optional with possible whitespace at the
end of the line. The return value would be ``value``.
Expects ``str`` input and output.
|
flac_to_mka/flac/metadata.py
|
ExtractProperty
|
lbianch/flac_to_mka
| 0 |
python
|
@staticmethod
def ExtractProperty(line, name):
'Helper method to deal with lines in a CUE sheet which\n have the form:\n name "value"\n where ``name`` may have whitespace inside it, before it, and\n the quote marks are optional with possible whitespace at the\n end of the line. The return value would be ``value``.\n\n Expects ``str`` input and output.'
line = line.replace('"', )
line = line.replace(name, )
return line.strip()
|
@staticmethod
def ExtractProperty(line, name):
'Helper method to deal with lines in a CUE sheet which\n have the form:\n name "value"\n where ``name`` may have whitespace inside it, before it, and\n the quote marks are optional with possible whitespace at the\n end of the line. The return value would be ``value``.\n\n Expects ``str`` input and output.'
line = line.replace('"', )
line = line.replace(name, )
return line.strip()<|docstring|>Helper method to deal with lines in a CUE sheet which
have the form:
name "value"
where ``name`` may have whitespace inside it, before it, and
the quote marks are optional with possible whitespace at the
end of the line. The return value would be ``value``.
Expects ``str`` input and output.<|endoftext|>
|
6e527f66db043226bae70ad55837bc0090db31bcd955a85cab9c2ea131399627
|
@staticmethod
def ExtractTrackInformation(lines):
"Get all the data about this track\n The lines variable holds the entire CUE sheet's lines\n index points to the element in the list which starts with\n ' TRACK' and we want to continue to get data about this track\n so long as our lines start with 4 spaces\n "
data = {'track': CueMetadata.ExtractProperty(lines[0], 'TRACK')[0:2].lstrip('0')}
times = {}
for line in lines[1:]:
if (not line.startswith((' ' * 4))):
break
line = line.strip()
if line.startswith('PERFORMER'):
continue
line = line.replace('INDEX ', 'INDEX')
line = line.replace('REM ', '')
name = line.split(' ')[0]
info = CueMetadata.ExtractProperty(line, name)
if (not info):
continue
name = name.lower()
if ('INDEX' in line):
times[name] = time.CueTimeToMKATime(info)
else:
data[name] = info
for idx in ['index01', 'index00']:
if (idx in times):
time_code = idx
break
else:
raise CueFormatError(f"No valid time codes found for track {data['track']}")
data['start_time'] = times[time_code]
return data
|
Get all the data about this track
The lines variable holds the entire CUE sheet's lines
index points to the element in the list which starts with
' TRACK' and we want to continue to get data about this track
so long as our lines start with 4 spaces
|
flac_to_mka/flac/metadata.py
|
ExtractTrackInformation
|
lbianch/flac_to_mka
| 0 |
python
|
@staticmethod
def ExtractTrackInformation(lines):
"Get all the data about this track\n The lines variable holds the entire CUE sheet's lines\n index points to the element in the list which starts with\n ' TRACK' and we want to continue to get data about this track\n so long as our lines start with 4 spaces\n "
data = {'track': CueMetadata.ExtractProperty(lines[0], 'TRACK')[0:2].lstrip('0')}
times = {}
for line in lines[1:]:
if (not line.startswith((' ' * 4))):
break
line = line.strip()
if line.startswith('PERFORMER'):
continue
line = line.replace('INDEX ', 'INDEX')
line = line.replace('REM ', )
name = line.split(' ')[0]
info = CueMetadata.ExtractProperty(line, name)
if (not info):
continue
name = name.lower()
if ('INDEX' in line):
times[name] = time.CueTimeToMKATime(info)
else:
data[name] = info
for idx in ['index01', 'index00']:
if (idx in times):
time_code = idx
break
else:
raise CueFormatError(f"No valid time codes found for track {data['track']}")
data['start_time'] = times[time_code]
return data
|
@staticmethod
def ExtractTrackInformation(lines):
"Get all the data about this track\n The lines variable holds the entire CUE sheet's lines\n index points to the element in the list which starts with\n ' TRACK' and we want to continue to get data about this track\n so long as our lines start with 4 spaces\n "
data = {'track': CueMetadata.ExtractProperty(lines[0], 'TRACK')[0:2].lstrip('0')}
times = {}
for line in lines[1:]:
if (not line.startswith((' ' * 4))):
break
line = line.strip()
if line.startswith('PERFORMER'):
continue
line = line.replace('INDEX ', 'INDEX')
line = line.replace('REM ', )
name = line.split(' ')[0]
info = CueMetadata.ExtractProperty(line, name)
if (not info):
continue
name = name.lower()
if ('INDEX' in line):
times[name] = time.CueTimeToMKATime(info)
else:
data[name] = info
for idx in ['index01', 'index00']:
if (idx in times):
time_code = idx
break
else:
raise CueFormatError(f"No valid time codes found for track {data['track']}")
data['start_time'] = times[time_code]
return data<|docstring|>Get all the data about this track
The lines variable holds the entire CUE sheet's lines
index points to the element in the list which starts with
' TRACK' and we want to continue to get data about this track
so long as our lines start with 4 spaces<|endoftext|>
|
9cd5dd7517419ceafdd0c4610c0810a36634ce75720a389d06b75b0bc6b467cc
|
@staticmethod
def ExtractFilename(line):
'Expects ``line`` to be a string of the form:\n FILE "Some filename.[wav|flac]" WAVE\n Uses the ``ExtractProperty`` method to convert this to\n Some filename.[wav|flac] WAVE\n and then removes the part after the extension.\n '
if (not line.startswith('FILE')):
raise RuntimeError("Can't extract filename from line not starting with 'FILE'")
line = CueMetadata.ExtractProperty(line, 'FILE')
line = line.split(' ')[:(- 1)]
return ' '.join(line)
|
Expects ``line`` to be a string of the form:
FILE "Some filename.[wav|flac]" WAVE
Uses the ``ExtractProperty`` method to convert this to
Some filename.[wav|flac] WAVE
and then removes the part after the extension.
|
flac_to_mka/flac/metadata.py
|
ExtractFilename
|
lbianch/flac_to_mka
| 0 |
python
|
@staticmethod
def ExtractFilename(line):
'Expects ``line`` to be a string of the form:\n FILE "Some filename.[wav|flac]" WAVE\n Uses the ``ExtractProperty`` method to convert this to\n Some filename.[wav|flac] WAVE\n and then removes the part after the extension.\n '
if (not line.startswith('FILE')):
raise RuntimeError("Can't extract filename from line not starting with 'FILE'")
line = CueMetadata.ExtractProperty(line, 'FILE')
line = line.split(' ')[:(- 1)]
return ' '.join(line)
|
@staticmethod
def ExtractFilename(line):
'Expects ``line`` to be a string of the form:\n FILE "Some filename.[wav|flac]" WAVE\n Uses the ``ExtractProperty`` method to convert this to\n Some filename.[wav|flac] WAVE\n and then removes the part after the extension.\n '
if (not line.startswith('FILE')):
raise RuntimeError("Can't extract filename from line not starting with 'FILE'")
line = CueMetadata.ExtractProperty(line, 'FILE')
line = line.split(' ')[:(- 1)]
return ' '.join(line)<|docstring|>Expects ``line`` to be a string of the form:
FILE "Some filename.[wav|flac]" WAVE
Uses the ``ExtractProperty`` method to convert this to
Some filename.[wav|flac] WAVE
and then removes the part after the extension.<|endoftext|>
|
b850cb512235f1958b48ce12fccc89c1a5723d4c2e4ec9aaead4df382e5a78e3
|
def hitTest(*args, **kwargs):
'\n The hitTestcommand hit-tests a point in the named control and returns a list of items underneath the point. The point is\n specified in pixels with the origin (0,0) at the top-left corner. This position is compatible with the coordinates\n provided by a drop-callback. The types of items that may be returned depends upon the specific control; not all controls\n currently support hit-testing.\n \n \n Derived from mel command `maya.cmds.hitTest`\n '
pass
|
The hitTestcommand hit-tests a point in the named control and returns a list of items underneath the point. The point is
specified in pixels with the origin (0,0) at the top-left corner. This position is compatible with the coordinates
provided by a drop-callback. The types of items that may be returned depends upon the specific control; not all controls
currently support hit-testing.
Derived from mel command `maya.cmds.hitTest`
|
mayaSDK/pymel/core/system.py
|
hitTest
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def hitTest(*args, **kwargs):
'\n The hitTestcommand hit-tests a point in the named control and returns a list of items underneath the point. The point is\n specified in pixels with the origin (0,0) at the top-left corner. This position is compatible with the coordinates\n provided by a drop-callback. The types of items that may be returned depends upon the specific control; not all controls\n currently support hit-testing.\n \n \n Derived from mel command `maya.cmds.hitTest`\n '
pass
|
def hitTest(*args, **kwargs):
'\n The hitTestcommand hit-tests a point in the named control and returns a list of items underneath the point. The point is\n specified in pixels with the origin (0,0) at the top-left corner. This position is compatible with the coordinates\n provided by a drop-callback. The types of items that may be returned depends upon the specific control; not all controls\n currently support hit-testing.\n \n \n Derived from mel command `maya.cmds.hitTest`\n '
pass<|docstring|>The hitTestcommand hit-tests a point in the named control and returns a list of items underneath the point. The point is
specified in pixels with the origin (0,0) at the top-left corner. This position is compatible with the coordinates
provided by a drop-callback. The types of items that may be returned depends upon the specific control; not all controls
currently support hit-testing.
Derived from mel command `maya.cmds.hitTest`<|endoftext|>
|
4bcc4f211060c6a5d7ec294220a13aee160dbb8a0032dc4cc32496143030098d
|
def displayString(*args, **kwargs):
"\n Assign a string value to a string identifier. Allows you define a string in one location and then refer to it by its\n identifier in many other locations. Formatted strings are also supported (NOTE however, this functionality is now\n provided in a more general fashion by the format command, use of format is recommended). You may embed up to 3 special\n character sequences ^1s, ^2s, and ^3s to perform automatic string replacement. The embedded characters will be replaced\n with the extra command arguments. See example section for more detail. Note the extra command arguments do not need to\n be display string identifiers. In query mode, return type is based on queried flag.\n \n Flags:\n - delete : d (bool) [create]\n This flag is used to remove an identifer string. The command will fail if the identifier does not exist.\n \n - exists : ex (bool) [create]\n Returns true or false depending upon whether the specified identifier exists.\n \n - keys : k (bool) [create,query]\n List all displayString keys that match the identifier string. The identifier string may be a whole or partial key\n string. The command will return a list of all identifier keys that contain this identifier string as a substring.\n \n - replace : r (bool) [create,query]\n Since a displayString command will fail if it tries to assign a new value to an existing identifer, this flag is\n required to allow updates to the value of an already-existing identifier. If the identifier does not already exist, a\n new identifier is added as if the -replace flag were not present.\n \n - value : v (unicode) [create,query]\n The display string's value. If you do not specify this flag when creating a display string then the value will be the\n same as the identifier. Flag can have multiple arguments, passed either as a tuple or a\n list.\n \n \n Derived from mel command `maya.cmds.displayString`\n "
pass
|
Assign a string value to a string identifier. Allows you define a string in one location and then refer to it by its
identifier in many other locations. Formatted strings are also supported (NOTE however, this functionality is now
provided in a more general fashion by the format command, use of format is recommended). You may embed up to 3 special
character sequences ^1s, ^2s, and ^3s to perform automatic string replacement. The embedded characters will be replaced
with the extra command arguments. See example section for more detail. Note the extra command arguments do not need to
be display string identifiers. In query mode, return type is based on queried flag.
Flags:
- delete : d (bool) [create]
This flag is used to remove an identifer string. The command will fail if the identifier does not exist.
- exists : ex (bool) [create]
Returns true or false depending upon whether the specified identifier exists.
- keys : k (bool) [create,query]
List all displayString keys that match the identifier string. The identifier string may be a whole or partial key
string. The command will return a list of all identifier keys that contain this identifier string as a substring.
- replace : r (bool) [create,query]
Since a displayString command will fail if it tries to assign a new value to an existing identifer, this flag is
required to allow updates to the value of an already-existing identifier. If the identifier does not already exist, a
new identifier is added as if the -replace flag were not present.
- value : v (unicode) [create,query]
The display string's value. If you do not specify this flag when creating a display string then the value will be the
same as the identifier. Flag can have multiple arguments, passed either as a tuple or a
list.
Derived from mel command `maya.cmds.displayString`
|
mayaSDK/pymel/core/system.py
|
displayString
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def displayString(*args, **kwargs):
"\n Assign a string value to a string identifier. Allows you define a string in one location and then refer to it by its\n identifier in many other locations. Formatted strings are also supported (NOTE however, this functionality is now\n provided in a more general fashion by the format command, use of format is recommended). You may embed up to 3 special\n character sequences ^1s, ^2s, and ^3s to perform automatic string replacement. The embedded characters will be replaced\n with the extra command arguments. See example section for more detail. Note the extra command arguments do not need to\n be display string identifiers. In query mode, return type is based on queried flag.\n \n Flags:\n - delete : d (bool) [create]\n This flag is used to remove an identifer string. The command will fail if the identifier does not exist.\n \n - exists : ex (bool) [create]\n Returns true or false depending upon whether the specified identifier exists.\n \n - keys : k (bool) [create,query]\n List all displayString keys that match the identifier string. The identifier string may be a whole or partial key\n string. The command will return a list of all identifier keys that contain this identifier string as a substring.\n \n - replace : r (bool) [create,query]\n Since a displayString command will fail if it tries to assign a new value to an existing identifer, this flag is\n required to allow updates to the value of an already-existing identifier. If the identifier does not already exist, a\n new identifier is added as if the -replace flag were not present.\n \n - value : v (unicode) [create,query]\n The display string's value. If you do not specify this flag when creating a display string then the value will be the\n same as the identifier. Flag can have multiple arguments, passed either as a tuple or a\n list.\n \n \n Derived from mel command `maya.cmds.displayString`\n "
pass
|
def displayString(*args, **kwargs):
"\n Assign a string value to a string identifier. Allows you define a string in one location and then refer to it by its\n identifier in many other locations. Formatted strings are also supported (NOTE however, this functionality is now\n provided in a more general fashion by the format command, use of format is recommended). You may embed up to 3 special\n character sequences ^1s, ^2s, and ^3s to perform automatic string replacement. The embedded characters will be replaced\n with the extra command arguments. See example section for more detail. Note the extra command arguments do not need to\n be display string identifiers. In query mode, return type is based on queried flag.\n \n Flags:\n - delete : d (bool) [create]\n This flag is used to remove an identifer string. The command will fail if the identifier does not exist.\n \n - exists : ex (bool) [create]\n Returns true or false depending upon whether the specified identifier exists.\n \n - keys : k (bool) [create,query]\n List all displayString keys that match the identifier string. The identifier string may be a whole or partial key\n string. The command will return a list of all identifier keys that contain this identifier string as a substring.\n \n - replace : r (bool) [create,query]\n Since a displayString command will fail if it tries to assign a new value to an existing identifer, this flag is\n required to allow updates to the value of an already-existing identifier. If the identifier does not already exist, a\n new identifier is added as if the -replace flag were not present.\n \n - value : v (unicode) [create,query]\n The display string's value. If you do not specify this flag when creating a display string then the value will be the\n same as the identifier. Flag can have multiple arguments, passed either as a tuple or a\n list.\n \n \n Derived from mel command `maya.cmds.displayString`\n "
pass<|docstring|>Assign a string value to a string identifier. Allows you define a string in one location and then refer to it by its
identifier in many other locations. Formatted strings are also supported (NOTE however, this functionality is now
provided in a more general fashion by the format command, use of format is recommended). You may embed up to 3 special
character sequences ^1s, ^2s, and ^3s to perform automatic string replacement. The embedded characters will be replaced
with the extra command arguments. See example section for more detail. Note the extra command arguments do not need to
be display string identifiers. In query mode, return type is based on queried flag.
Flags:
- delete : d (bool) [create]
This flag is used to remove an identifer string. The command will fail if the identifier does not exist.
- exists : ex (bool) [create]
Returns true or false depending upon whether the specified identifier exists.
- keys : k (bool) [create,query]
List all displayString keys that match the identifier string. The identifier string may be a whole or partial key
string. The command will return a list of all identifier keys that contain this identifier string as a substring.
- replace : r (bool) [create,query]
Since a displayString command will fail if it tries to assign a new value to an existing identifer, this flag is
required to allow updates to the value of an already-existing identifier. If the identifier does not already exist, a
new identifier is added as if the -replace flag were not present.
- value : v (unicode) [create,query]
The display string's value. If you do not specify this flag when creating a display string then the value will be the
same as the identifier. Flag can have multiple arguments, passed either as a tuple or a
list.
Derived from mel command `maya.cmds.displayString`<|endoftext|>
|
adaaa3a3026c38595b241962337d0952a2c5d2f5c1a101c817a11c861b56cf3e
|
def timerX(*args, **kwargs):
'\n Used to calculate elapsed time. This command returns sub-second accurate time values. It is useful from scripts for\n timing the length of operations. Call this command before and after the operation you wish to time. On the first call,\n do not use any flags. It will return the start time. Save this value. After the operation, call this command a second\n time, and pass the saved start time using the -st flag. The elapsed time will be returned.\n \n Flags:\n - startTime : st (float) [create]\n When this flag is used, the command returns the elapsed time since the specified start time. Flag can\n have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.timerX`\n '
pass
|
Used to calculate elapsed time. This command returns sub-second accurate time values. It is useful from scripts for
timing the length of operations. Call this command before and after the operation you wish to time. On the first call,
do not use any flags. It will return the start time. Save this value. After the operation, call this command a second
time, and pass the saved start time using the -st flag. The elapsed time will be returned.
Flags:
- startTime : st (float) [create]
When this flag is used, the command returns the elapsed time since the specified start time. Flag can
have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.timerX`
|
mayaSDK/pymel/core/system.py
|
timerX
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def timerX(*args, **kwargs):
'\n Used to calculate elapsed time. This command returns sub-second accurate time values. It is useful from scripts for\n timing the length of operations. Call this command before and after the operation you wish to time. On the first call,\n do not use any flags. It will return the start time. Save this value. After the operation, call this command a second\n time, and pass the saved start time using the -st flag. The elapsed time will be returned.\n \n Flags:\n - startTime : st (float) [create]\n When this flag is used, the command returns the elapsed time since the specified start time. Flag can\n have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.timerX`\n '
pass
|
def timerX(*args, **kwargs):
'\n Used to calculate elapsed time. This command returns sub-second accurate time values. It is useful from scripts for\n timing the length of operations. Call this command before and after the operation you wish to time. On the first call,\n do not use any flags. It will return the start time. Save this value. After the operation, call this command a second\n time, and pass the saved start time using the -st flag. The elapsed time will be returned.\n \n Flags:\n - startTime : st (float) [create]\n When this flag is used, the command returns the elapsed time since the specified start time. Flag can\n have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.timerX`\n '
pass<|docstring|>Used to calculate elapsed time. This command returns sub-second accurate time values. It is useful from scripts for
timing the length of operations. Call this command before and after the operation you wish to time. On the first call,
do not use any flags. It will return the start time. Save this value. After the operation, call this command a second
time, and pass the saved start time using the -st flag. The elapsed time will be returned.
Flags:
- startTime : st (float) [create]
When this flag is used, the command returns the elapsed time since the specified start time. Flag can
have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.timerX`<|endoftext|>
|
4bc52f8293e6f1b69f795d52afb29cdd73c0559513b9ceaa7194a69b720d2cbd
|
def requires(*args, **kwargs):
'\n This command is used during file I/O to specify the requirements needed to load the given file. It defines what file\n format version was used to write the file, or what plug-ins are required to load the scene. The first string names a\n product (either maya, or a plug-in name) The second string gives the version. This command is only useful during file\n I/O, so users should not have any need to use this command themselves. The flags -nodeTypeand -dataTypespecify the node\n types and data types defined by the plug-in. When Maya open a scene file, it runs requirescommand in the file and load\n required plug-ins. But some plug-ins may be not loaded because they are missing. The flags -nodeTypeand -dataTypeare\n used by the missing plug-ins. If one plug-in is missing, nodes and data created by this plug-in are created as unknown\n nodes and unknown data. Maya records their original types for these unknown nodes and data. When these nodes and data\n are saved back to file, it will be possible to determine the associated missing plug-ins. And when export selected\n nodes, Maya can write out the exact required plug-ins. The flags -nodeTypeand -dataTypeis optional. In this command, if\n these flags are not given for one plug-in and the plug-in is missing, the requirescommand of this plug-in will always be\n saved back.\n \n Flags:\n - dataType : dt (unicode) [create]\n Specify a data type defined by this plug-in. The data type is specified by MFnPlugin::registerData() when register the\n plug-in.\n \n - nodeType : nt (unicode) [create]\n Specify a node type defined by this plug-in. The node type is specified by MFnPlugin::registerNode() when register the\n plug-in. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.requires`\n '
pass
|
This command is used during file I/O to specify the requirements needed to load the given file. It defines what file
format version was used to write the file, or what plug-ins are required to load the scene. The first string names a
product (either maya, or a plug-in name) The second string gives the version. This command is only useful during file
I/O, so users should not have any need to use this command themselves. The flags -nodeTypeand -dataTypespecify the node
types and data types defined by the plug-in. When Maya open a scene file, it runs requirescommand in the file and load
required plug-ins. But some plug-ins may be not loaded because they are missing. The flags -nodeTypeand -dataTypeare
used by the missing plug-ins. If one plug-in is missing, nodes and data created by this plug-in are created as unknown
nodes and unknown data. Maya records their original types for these unknown nodes and data. When these nodes and data
are saved back to file, it will be possible to determine the associated missing plug-ins. And when export selected
nodes, Maya can write out the exact required plug-ins. The flags -nodeTypeand -dataTypeis optional. In this command, if
these flags are not given for one plug-in and the plug-in is missing, the requirescommand of this plug-in will always be
saved back.
Flags:
- dataType : dt (unicode) [create]
Specify a data type defined by this plug-in. The data type is specified by MFnPlugin::registerData() when register the
plug-in.
- nodeType : nt (unicode) [create]
Specify a node type defined by this plug-in. The node type is specified by MFnPlugin::registerNode() when register the
plug-in. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.requires`
|
mayaSDK/pymel/core/system.py
|
requires
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def requires(*args, **kwargs):
'\n This command is used during file I/O to specify the requirements needed to load the given file. It defines what file\n format version was used to write the file, or what plug-ins are required to load the scene. The first string names a\n product (either maya, or a plug-in name) The second string gives the version. This command is only useful during file\n I/O, so users should not have any need to use this command themselves. The flags -nodeTypeand -dataTypespecify the node\n types and data types defined by the plug-in. When Maya open a scene file, it runs requirescommand in the file and load\n required plug-ins. But some plug-ins may be not loaded because they are missing. The flags -nodeTypeand -dataTypeare\n used by the missing plug-ins. If one plug-in is missing, nodes and data created by this plug-in are created as unknown\n nodes and unknown data. Maya records their original types for these unknown nodes and data. When these nodes and data\n are saved back to file, it will be possible to determine the associated missing plug-ins. And when export selected\n nodes, Maya can write out the exact required plug-ins. The flags -nodeTypeand -dataTypeis optional. In this command, if\n these flags are not given for one plug-in and the plug-in is missing, the requirescommand of this plug-in will always be\n saved back.\n \n Flags:\n - dataType : dt (unicode) [create]\n Specify a data type defined by this plug-in. The data type is specified by MFnPlugin::registerData() when register the\n plug-in.\n \n - nodeType : nt (unicode) [create]\n Specify a node type defined by this plug-in. The node type is specified by MFnPlugin::registerNode() when register the\n plug-in. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.requires`\n '
pass
|
def requires(*args, **kwargs):
'\n This command is used during file I/O to specify the requirements needed to load the given file. It defines what file\n format version was used to write the file, or what plug-ins are required to load the scene. The first string names a\n product (either maya, or a plug-in name) The second string gives the version. This command is only useful during file\n I/O, so users should not have any need to use this command themselves. The flags -nodeTypeand -dataTypespecify the node\n types and data types defined by the plug-in. When Maya open a scene file, it runs requirescommand in the file and load\n required plug-ins. But some plug-ins may be not loaded because they are missing. The flags -nodeTypeand -dataTypeare\n used by the missing plug-ins. If one plug-in is missing, nodes and data created by this plug-in are created as unknown\n nodes and unknown data. Maya records their original types for these unknown nodes and data. When these nodes and data\n are saved back to file, it will be possible to determine the associated missing plug-ins. And when export selected\n nodes, Maya can write out the exact required plug-ins. The flags -nodeTypeand -dataTypeis optional. In this command, if\n these flags are not given for one plug-in and the plug-in is missing, the requirescommand of this plug-in will always be\n saved back.\n \n Flags:\n - dataType : dt (unicode) [create]\n Specify a data type defined by this plug-in. The data type is specified by MFnPlugin::registerData() when register the\n plug-in.\n \n - nodeType : nt (unicode) [create]\n Specify a node type defined by this plug-in. The node type is specified by MFnPlugin::registerNode() when register the\n plug-in. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.requires`\n '
pass<|docstring|>This command is used during file I/O to specify the requirements needed to load the given file. It defines what file
format version was used to write the file, or what plug-ins are required to load the scene. The first string names a
product (either maya, or a plug-in name) The second string gives the version. This command is only useful during file
I/O, so users should not have any need to use this command themselves. The flags -nodeTypeand -dataTypespecify the node
types and data types defined by the plug-in. When Maya open a scene file, it runs requirescommand in the file and load
required plug-ins. But some plug-ins may be not loaded because they are missing. The flags -nodeTypeand -dataTypeare
used by the missing plug-ins. If one plug-in is missing, nodes and data created by this plug-in are created as unknown
nodes and unknown data. Maya records their original types for these unknown nodes and data. When these nodes and data
are saved back to file, it will be possible to determine the associated missing plug-ins. And when export selected
nodes, Maya can write out the exact required plug-ins. The flags -nodeTypeand -dataTypeis optional. In this command, if
these flags are not given for one plug-in and the plug-in is missing, the requirescommand of this plug-in will always be
saved back.
Flags:
- dataType : dt (unicode) [create]
Specify a data type defined by this plug-in. The data type is specified by MFnPlugin::registerData() when register the
plug-in.
- nodeType : nt (unicode) [create]
Specify a node type defined by this plug-in. The node type is specified by MFnPlugin::registerNode() when register the
plug-in. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.requires`<|endoftext|>
|
7e675c21a4aaa2d87e435c431f24d4d37119d3444f19326680fbb35ebb8ada5e
|
def dbcount(*args, **kwargs):
"\n The dbcountcommand is used to print and manage a list of statistics collected for counting operations. These statistics\n are displayed as a list of hits on a particular location in code, with added reference information for\n pointers/strings/whatever. If -reset is not specified then statistics are printed.\n \n Flags:\n - enabled : e (bool) [create]\n Set the enabled state of the counters ('on' to enable, 'off' to disable). Returns the list of all counters affected.\n \n - file : f (unicode) [create]\n Destination file of the enabled count objects. Use the special names stdoutand stderrto redirect to your command\n window. As well, the special name msdevis available on NT to direct your output to the debug tab in the output window\n of Developer Studio.\n \n - keyword : k (unicode) [create]\n Print only the counters whose name matches this keyword (default is all).\n \n - list : l (bool) [create]\n List all available counters and their current enabled status. (The only thing you can do when counters are disabled.)\n \n - maxdepth : md (int) [create]\n Maximum number of levels down to traverse and report. 0 is the default and it means continue recursing as many times as\n are requested.\n \n - quick : q (bool) [create]\n Display only a summary for each counter type instead of the full details.\n \n - reset : r (bool) [create]\n Reset all counters back to 0 and remove all but the top level counters. Returns the list of all counters affected.\n \n - spreadsheet : s (bool) [create]\n Display in spreadsheet format instead of the usual nested braces. This will include a header row that contains 'Count\n Level1 Level2 Level3...', making the data suitable for opening directly in a spreadsheet table.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dbcount`\n "
pass
|
The dbcountcommand is used to print and manage a list of statistics collected for counting operations. These statistics
are displayed as a list of hits on a particular location in code, with added reference information for
pointers/strings/whatever. If -reset is not specified then statistics are printed.
Flags:
- enabled : e (bool) [create]
Set the enabled state of the counters ('on' to enable, 'off' to disable). Returns the list of all counters affected.
- file : f (unicode) [create]
Destination file of the enabled count objects. Use the special names stdoutand stderrto redirect to your command
window. As well, the special name msdevis available on NT to direct your output to the debug tab in the output window
of Developer Studio.
- keyword : k (unicode) [create]
Print only the counters whose name matches this keyword (default is all).
- list : l (bool) [create]
List all available counters and their current enabled status. (The only thing you can do when counters are disabled.)
- maxdepth : md (int) [create]
Maximum number of levels down to traverse and report. 0 is the default and it means continue recursing as many times as
are requested.
- quick : q (bool) [create]
Display only a summary for each counter type instead of the full details.
- reset : r (bool) [create]
Reset all counters back to 0 and remove all but the top level counters. Returns the list of all counters affected.
- spreadsheet : s (bool) [create]
Display in spreadsheet format instead of the usual nested braces. This will include a header row that contains 'Count
Level1 Level2 Level3...', making the data suitable for opening directly in a spreadsheet table.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dbcount`
|
mayaSDK/pymel/core/system.py
|
dbcount
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def dbcount(*args, **kwargs):
"\n The dbcountcommand is used to print and manage a list of statistics collected for counting operations. These statistics\n are displayed as a list of hits on a particular location in code, with added reference information for\n pointers/strings/whatever. If -reset is not specified then statistics are printed.\n \n Flags:\n - enabled : e (bool) [create]\n Set the enabled state of the counters ('on' to enable, 'off' to disable). Returns the list of all counters affected.\n \n - file : f (unicode) [create]\n Destination file of the enabled count objects. Use the special names stdoutand stderrto redirect to your command\n window. As well, the special name msdevis available on NT to direct your output to the debug tab in the output window\n of Developer Studio.\n \n - keyword : k (unicode) [create]\n Print only the counters whose name matches this keyword (default is all).\n \n - list : l (bool) [create]\n List all available counters and their current enabled status. (The only thing you can do when counters are disabled.)\n \n - maxdepth : md (int) [create]\n Maximum number of levels down to traverse and report. 0 is the default and it means continue recursing as many times as\n are requested.\n \n - quick : q (bool) [create]\n Display only a summary for each counter type instead of the full details.\n \n - reset : r (bool) [create]\n Reset all counters back to 0 and remove all but the top level counters. Returns the list of all counters affected.\n \n - spreadsheet : s (bool) [create]\n Display in spreadsheet format instead of the usual nested braces. This will include a header row that contains 'Count\n Level1 Level2 Level3...', making the data suitable for opening directly in a spreadsheet table.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dbcount`\n "
pass
|
def dbcount(*args, **kwargs):
"\n The dbcountcommand is used to print and manage a list of statistics collected for counting operations. These statistics\n are displayed as a list of hits on a particular location in code, with added reference information for\n pointers/strings/whatever. If -reset is not specified then statistics are printed.\n \n Flags:\n - enabled : e (bool) [create]\n Set the enabled state of the counters ('on' to enable, 'off' to disable). Returns the list of all counters affected.\n \n - file : f (unicode) [create]\n Destination file of the enabled count objects. Use the special names stdoutand stderrto redirect to your command\n window. As well, the special name msdevis available on NT to direct your output to the debug tab in the output window\n of Developer Studio.\n \n - keyword : k (unicode) [create]\n Print only the counters whose name matches this keyword (default is all).\n \n - list : l (bool) [create]\n List all available counters and their current enabled status. (The only thing you can do when counters are disabled.)\n \n - maxdepth : md (int) [create]\n Maximum number of levels down to traverse and report. 0 is the default and it means continue recursing as many times as\n are requested.\n \n - quick : q (bool) [create]\n Display only a summary for each counter type instead of the full details.\n \n - reset : r (bool) [create]\n Reset all counters back to 0 and remove all but the top level counters. Returns the list of all counters affected.\n \n - spreadsheet : s (bool) [create]\n Display in spreadsheet format instead of the usual nested braces. This will include a header row that contains 'Count\n Level1 Level2 Level3...', making the data suitable for opening directly in a spreadsheet table.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dbcount`\n "
pass<|docstring|>The dbcountcommand is used to print and manage a list of statistics collected for counting operations. These statistics
are displayed as a list of hits on a particular location in code, with added reference information for
pointers/strings/whatever. If -reset is not specified then statistics are printed.
Flags:
- enabled : e (bool) [create]
Set the enabled state of the counters ('on' to enable, 'off' to disable). Returns the list of all counters affected.
- file : f (unicode) [create]
Destination file of the enabled count objects. Use the special names stdoutand stderrto redirect to your command
window. As well, the special name msdevis available on NT to direct your output to the debug tab in the output window
of Developer Studio.
- keyword : k (unicode) [create]
Print only the counters whose name matches this keyword (default is all).
- list : l (bool) [create]
List all available counters and their current enabled status. (The only thing you can do when counters are disabled.)
- maxdepth : md (int) [create]
Maximum number of levels down to traverse and report. 0 is the default and it means continue recursing as many times as
are requested.
- quick : q (bool) [create]
Display only a summary for each counter type instead of the full details.
- reset : r (bool) [create]
Reset all counters back to 0 and remove all but the top level counters. Returns the list of all counters affected.
- spreadsheet : s (bool) [create]
Display in spreadsheet format instead of the usual nested braces. This will include a header row that contains 'Count
Level1 Level2 Level3...', making the data suitable for opening directly in a spreadsheet table.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dbcount`<|endoftext|>
|
c3540e23db3ff790f6a9b86a80163598f49957c69cacbc7b7e636c83ba9eb190
|
def exportSelected(exportPath, **kwargs):
'\n Export the selected items into the specified file. Returns the name of the exported file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - constructionHistory:\n For use with exportSelected to specify whether attached construction history should be included in the export.\n - channels:\n For use with exportSelected to specify whether attached channels should be included in the export.\n - constraints:\n For use with exportSelected to specify whether attached constraints should be included in the export.\n - expressions:\n For use with exportSelected to specify whether attached expressions should be included in the export.\n - shader:\n For use with exportSelected to specify whether attached shaders should be included in the export.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Export the selected items into the specified file. Returns the name of the exported file.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- constructionHistory:
For use with exportSelected to specify whether attached construction history should be included in the export.
- channels:
For use with exportSelected to specify whether attached channels should be included in the export.
- constraints:
For use with exportSelected to specify whether attached constraints should be included in the export.
- expressions:
For use with exportSelected to specify whether attached expressions should be included in the export.
- shader:
For use with exportSelected to specify whether attached shaders should be included in the export.
- preserveReferences:
Modifies the various import/export flags such that references are imported/exported as actual references rather than
copies of those references.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
exportSelected
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def exportSelected(exportPath, **kwargs):
'\n Export the selected items into the specified file. Returns the name of the exported file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - constructionHistory:\n For use with exportSelected to specify whether attached construction history should be included in the export.\n - channels:\n For use with exportSelected to specify whether attached channels should be included in the export.\n - constraints:\n For use with exportSelected to specify whether attached constraints should be included in the export.\n - expressions:\n For use with exportSelected to specify whether attached expressions should be included in the export.\n - shader:\n For use with exportSelected to specify whether attached shaders should be included in the export.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def exportSelected(exportPath, **kwargs):
'\n Export the selected items into the specified file. Returns the name of the exported file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - constructionHistory:\n For use with exportSelected to specify whether attached construction history should be included in the export.\n - channels:\n For use with exportSelected to specify whether attached channels should be included in the export.\n - constraints:\n For use with exportSelected to specify whether attached constraints should be included in the export.\n - expressions:\n For use with exportSelected to specify whether attached expressions should be included in the export.\n - shader:\n For use with exportSelected to specify whether attached shaders should be included in the export.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Export the selected items into the specified file. Returns the name of the exported file.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- constructionHistory:
For use with exportSelected to specify whether attached construction history should be included in the export.
- channels:
For use with exportSelected to specify whether attached channels should be included in the export.
- constraints:
For use with exportSelected to specify whether attached constraints should be included in the export.
- expressions:
For use with exportSelected to specify whether attached expressions should be included in the export.
- shader:
For use with exportSelected to specify whether attached shaders should be included in the export.
- preserveReferences:
Modifies the various import/export flags such that references are imported/exported as actual references rather than
copies of those references.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
3c6c38467e957db840fca8cb51653facf919b36dd2adc96393dc91263d6c9e6e
|
def untitledFileName():
'\n Obtain the base filename used for untitled scenes. In localized environments, this string will contain a translated value.\n '
pass
|
Obtain the base filename used for untitled scenes. In localized environments, this string will contain a translated value.
|
mayaSDK/pymel/core/system.py
|
untitledFileName
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def untitledFileName():
'\n \n '
pass
|
def untitledFileName():
'\n \n '
pass<|docstring|>Obtain the base filename used for untitled scenes. In localized environments, this string will contain a translated value.<|endoftext|>
|
eff298961eaebf1d8bed178f97d5b66109911f4cb9164ae3fe658e262e7fa733
|
def fileDialog(*args, **kwargs):
'\n The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is\n recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both\n fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the\n fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be\n able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an\n example of how to change a script to use fileDialog2.\n \n Flags:\n - application : app (bool) [create]\n This is a Maconly flag. This brings up the dialog which selects only the application bundle.\n \n - defaultFileName : dfn (unicode) [create]\n Set default file name. This flag is available under writemode\n \n - directoryMask : dm (unicode) [create]\n This can be used to specify what directory and file names will be displayed in the dialog. If not specified, the\n current directory will be used, with all files displayed. The string may contain a path name, and must contain a wild-\n carded file specifier. (eg \\*.ccor /usr/u/\\*) If just a path is specified, then the last directory in the path is taken\n to be a file specifier, and this will not produce the desired results.\n \n - mode : m (int) [create]\n Defines the mode in which to run the file dialog: 0 for read1 for writeWrite mode can not be used in conjunction with\n the -application flag.\n \n - title : t (unicode) [create]\n Set title text. The default value under writemode is Save As. The default value under readmode is Open.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.fileDialog`\n '
pass
|
The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is
recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both
fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the
fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be
able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an
example of how to change a script to use fileDialog2.
Flags:
- application : app (bool) [create]
This is a Maconly flag. This brings up the dialog which selects only the application bundle.
- defaultFileName : dfn (unicode) [create]
Set default file name. This flag is available under writemode
- directoryMask : dm (unicode) [create]
This can be used to specify what directory and file names will be displayed in the dialog. If not specified, the
current directory will be used, with all files displayed. The string may contain a path name, and must contain a wild-
carded file specifier. (eg \*.ccor /usr/u/\*) If just a path is specified, then the last directory in the path is taken
to be a file specifier, and this will not produce the desired results.
- mode : m (int) [create]
Defines the mode in which to run the file dialog: 0 for read1 for writeWrite mode can not be used in conjunction with
the -application flag.
- title : t (unicode) [create]
Set title text. The default value under writemode is Save As. The default value under readmode is Open.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.fileDialog`
|
mayaSDK/pymel/core/system.py
|
fileDialog
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def fileDialog(*args, **kwargs):
'\n The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is\n recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both\n fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the\n fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be\n able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an\n example of how to change a script to use fileDialog2.\n \n Flags:\n - application : app (bool) [create]\n This is a Maconly flag. This brings up the dialog which selects only the application bundle.\n \n - defaultFileName : dfn (unicode) [create]\n Set default file name. This flag is available under writemode\n \n - directoryMask : dm (unicode) [create]\n This can be used to specify what directory and file names will be displayed in the dialog. If not specified, the\n current directory will be used, with all files displayed. The string may contain a path name, and must contain a wild-\n carded file specifier. (eg \\*.ccor /usr/u/\\*) If just a path is specified, then the last directory in the path is taken\n to be a file specifier, and this will not produce the desired results.\n \n - mode : m (int) [create]\n Defines the mode in which to run the file dialog: 0 for read1 for writeWrite mode can not be used in conjunction with\n the -application flag.\n \n - title : t (unicode) [create]\n Set title text. The default value under writemode is Save As. The default value under readmode is Open.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.fileDialog`\n '
pass
|
def fileDialog(*args, **kwargs):
'\n The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is\n recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both\n fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the\n fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be\n able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an\n example of how to change a script to use fileDialog2.\n \n Flags:\n - application : app (bool) [create]\n This is a Maconly flag. This brings up the dialog which selects only the application bundle.\n \n - defaultFileName : dfn (unicode) [create]\n Set default file name. This flag is available under writemode\n \n - directoryMask : dm (unicode) [create]\n This can be used to specify what directory and file names will be displayed in the dialog. If not specified, the\n current directory will be used, with all files displayed. The string may contain a path name, and must contain a wild-\n carded file specifier. (eg \\*.ccor /usr/u/\\*) If just a path is specified, then the last directory in the path is taken\n to be a file specifier, and this will not produce the desired results.\n \n - mode : m (int) [create]\n Defines the mode in which to run the file dialog: 0 for read1 for writeWrite mode can not be used in conjunction with\n the -application flag.\n \n - title : t (unicode) [create]\n Set title text. The default value under writemode is Save As. The default value under readmode is Open.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.fileDialog`\n '
pass<|docstring|>The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is
recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both
fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the
fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be
able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an
example of how to change a script to use fileDialog2.
Flags:
- application : app (bool) [create]
This is a Maconly flag. This brings up the dialog which selects only the application bundle.
- defaultFileName : dfn (unicode) [create]
Set default file name. This flag is available under writemode
- directoryMask : dm (unicode) [create]
This can be used to specify what directory and file names will be displayed in the dialog. If not specified, the
current directory will be used, with all files displayed. The string may contain a path name, and must contain a wild-
carded file specifier. (eg \*.ccor /usr/u/\*) If just a path is specified, then the last directory in the path is taken
to be a file specifier, and this will not produce the desired results.
- mode : m (int) [create]
Defines the mode in which to run the file dialog: 0 for read1 for writeWrite mode can not be used in conjunction with
the -application flag.
- title : t (unicode) [create]
Set title text. The default value under writemode is Save As. The default value under readmode is Open.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.fileDialog`<|endoftext|>
|
5d68792cd7c033ba2467efb25b12eb2f0123bd08724cae65281db4f0f8b38515
|
def dbtrace(*args, **kwargs):
"\n The dbtracecommand is used to manipulate trace objects. The keyword is the only mandatory argument, indicating\n which trace object is to be altered. Trace Objects to affect (keywordKEY)Optional filtering criteria\n (filterFILTER)Function (off, outputFILE, mark, titleTITLE, timed: default operation is to enable traces)You can use the\n query mode to find out which keywords are currently active (query with no arguments) or inactive (query with\n the offargument). You can enhance that query with or without a keyword argument to find out where\n their output is going (query with the outputargument), out what filters are currently applied (query with the\n filterargument), or if their output will be timestamped (query with the timedargument). In\n query mode, return type is based on queried flag.\n \n Flags:\n - filter : f (unicode) [create,query]\n Set the filter object for these trace objects (see 'dgfilter')\n \n - info : i (bool) [query]\n In query mode return a brief description of the trace object.\n \n - keyword : k (unicode) [create,query]\n Keyword of the trace objects to affect In query mode, this flag can accept a value.\n \n - mark : m (bool) [create]\n Display a mark for all outputs of defined trace objects\n \n - off : boolean (Toggle the traces off. If omitted it will turn them on.) [create]\n \n - output : o (unicode) [create,query]\n Destination file of the affected trace objects. Use the special names stdoutand stderrto redirect to your command\n window. The special name msdevis available on Windows to direct your output to the debug tab in the output window of\n Visual Studio.\n \n - timed : tm (bool) [create,query]\n Turn on/off timing information in the output of the specified trace objects.\n \n - title : t (unicode) [create]\n Display a title mark for all outputs of defined trace objects\n \n - verbose : v (bool) [create]\n Include all traces in output and filter queries, not just those turned on. Flag can have\n multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dbtrace`\n "
pass
|
The dbtracecommand is used to manipulate trace objects. The keyword is the only mandatory argument, indicating
which trace object is to be altered. Trace Objects to affect (keywordKEY)Optional filtering criteria
(filterFILTER)Function (off, outputFILE, mark, titleTITLE, timed: default operation is to enable traces)You can use the
query mode to find out which keywords are currently active (query with no arguments) or inactive (query with
the offargument). You can enhance that query with or without a keyword argument to find out where
their output is going (query with the outputargument), out what filters are currently applied (query with the
filterargument), or if their output will be timestamped (query with the timedargument). In
query mode, return type is based on queried flag.
Flags:
- filter : f (unicode) [create,query]
Set the filter object for these trace objects (see 'dgfilter')
- info : i (bool) [query]
In query mode return a brief description of the trace object.
- keyword : k (unicode) [create,query]
Keyword of the trace objects to affect In query mode, this flag can accept a value.
- mark : m (bool) [create]
Display a mark for all outputs of defined trace objects
- off : boolean (Toggle the traces off. If omitted it will turn them on.) [create]
- output : o (unicode) [create,query]
Destination file of the affected trace objects. Use the special names stdoutand stderrto redirect to your command
window. The special name msdevis available on Windows to direct your output to the debug tab in the output window of
Visual Studio.
- timed : tm (bool) [create,query]
Turn on/off timing information in the output of the specified trace objects.
- title : t (unicode) [create]
Display a title mark for all outputs of defined trace objects
- verbose : v (bool) [create]
Include all traces in output and filter queries, not just those turned on. Flag can have
multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dbtrace`
|
mayaSDK/pymel/core/system.py
|
dbtrace
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def dbtrace(*args, **kwargs):
"\n The dbtracecommand is used to manipulate trace objects. The keyword is the only mandatory argument, indicating\n which trace object is to be altered. Trace Objects to affect (keywordKEY)Optional filtering criteria\n (filterFILTER)Function (off, outputFILE, mark, titleTITLE, timed: default operation is to enable traces)You can use the\n query mode to find out which keywords are currently active (query with no arguments) or inactive (query with\n the offargument). You can enhance that query with or without a keyword argument to find out where\n their output is going (query with the outputargument), out what filters are currently applied (query with the\n filterargument), or if their output will be timestamped (query with the timedargument). In\n query mode, return type is based on queried flag.\n \n Flags:\n - filter : f (unicode) [create,query]\n Set the filter object for these trace objects (see 'dgfilter')\n \n - info : i (bool) [query]\n In query mode return a brief description of the trace object.\n \n - keyword : k (unicode) [create,query]\n Keyword of the trace objects to affect In query mode, this flag can accept a value.\n \n - mark : m (bool) [create]\n Display a mark for all outputs of defined trace objects\n \n - off : boolean (Toggle the traces off. If omitted it will turn them on.) [create]\n \n - output : o (unicode) [create,query]\n Destination file of the affected trace objects. Use the special names stdoutand stderrto redirect to your command\n window. The special name msdevis available on Windows to direct your output to the debug tab in the output window of\n Visual Studio.\n \n - timed : tm (bool) [create,query]\n Turn on/off timing information in the output of the specified trace objects.\n \n - title : t (unicode) [create]\n Display a title mark for all outputs of defined trace objects\n \n - verbose : v (bool) [create]\n Include all traces in output and filter queries, not just those turned on. Flag can have\n multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dbtrace`\n "
pass
|
def dbtrace(*args, **kwargs):
"\n The dbtracecommand is used to manipulate trace objects. The keyword is the only mandatory argument, indicating\n which trace object is to be altered. Trace Objects to affect (keywordKEY)Optional filtering criteria\n (filterFILTER)Function (off, outputFILE, mark, titleTITLE, timed: default operation is to enable traces)You can use the\n query mode to find out which keywords are currently active (query with no arguments) or inactive (query with\n the offargument). You can enhance that query with or without a keyword argument to find out where\n their output is going (query with the outputargument), out what filters are currently applied (query with the\n filterargument), or if their output will be timestamped (query with the timedargument). In\n query mode, return type is based on queried flag.\n \n Flags:\n - filter : f (unicode) [create,query]\n Set the filter object for these trace objects (see 'dgfilter')\n \n - info : i (bool) [query]\n In query mode return a brief description of the trace object.\n \n - keyword : k (unicode) [create,query]\n Keyword of the trace objects to affect In query mode, this flag can accept a value.\n \n - mark : m (bool) [create]\n Display a mark for all outputs of defined trace objects\n \n - off : boolean (Toggle the traces off. If omitted it will turn them on.) [create]\n \n - output : o (unicode) [create,query]\n Destination file of the affected trace objects. Use the special names stdoutand stderrto redirect to your command\n window. The special name msdevis available on Windows to direct your output to the debug tab in the output window of\n Visual Studio.\n \n - timed : tm (bool) [create,query]\n Turn on/off timing information in the output of the specified trace objects.\n \n - title : t (unicode) [create]\n Display a title mark for all outputs of defined trace objects\n \n - verbose : v (bool) [create]\n Include all traces in output and filter queries, not just those turned on. Flag can have\n multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dbtrace`\n "
pass<|docstring|>The dbtracecommand is used to manipulate trace objects. The keyword is the only mandatory argument, indicating
which trace object is to be altered. Trace Objects to affect (keywordKEY)Optional filtering criteria
(filterFILTER)Function (off, outputFILE, mark, titleTITLE, timed: default operation is to enable traces)You can use the
query mode to find out which keywords are currently active (query with no arguments) or inactive (query with
the offargument). You can enhance that query with or without a keyword argument to find out where
their output is going (query with the outputargument), out what filters are currently applied (query with the
filterargument), or if their output will be timestamped (query with the timedargument). In
query mode, return type is based on queried flag.
Flags:
- filter : f (unicode) [create,query]
Set the filter object for these trace objects (see 'dgfilter')
- info : i (bool) [query]
In query mode return a brief description of the trace object.
- keyword : k (unicode) [create,query]
Keyword of the trace objects to affect In query mode, this flag can accept a value.
- mark : m (bool) [create]
Display a mark for all outputs of defined trace objects
- off : boolean (Toggle the traces off. If omitted it will turn them on.) [create]
- output : o (unicode) [create,query]
Destination file of the affected trace objects. Use the special names stdoutand stderrto redirect to your command
window. The special name msdevis available on Windows to direct your output to the debug tab in the output window of
Visual Studio.
- timed : tm (bool) [create,query]
Turn on/off timing information in the output of the specified trace objects.
- title : t (unicode) [create]
Display a title mark for all outputs of defined trace objects
- verbose : v (bool) [create]
Include all traces in output and filter queries, not just those turned on. Flag can have
multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dbtrace`<|endoftext|>
|
4d1813e51439bb2bfa316773f91e0f7fb53ff69cfaeaed6fe17e4b74357f5cc1
|
def findType(*args, **kwargs):
'\n The findTypecommand is used to search through a dependency subgraph on a certain node to find all nodes of the given\n type. The search can go either upstream (input connections) or downstream (output connections). The plug/attribute\n dependencies are not taken into account when searching for matching nodes, only the connections.\n \n Flags:\n - deep : d (bool) [create]\n Find all nodes of the given type instead of just the first.\n \n - exact : e (bool) [create]\n Match node types exactly instead of any in a node hierarchy.\n \n - forward : f (bool) [create]\n Look forwards (downstream) through the graph rather than backwards (upstream) for matching nodes.\n \n - type : t (unicode) [create]\n Type of node to look for (e.g. transform). This flag is mandatory. Flag can have\n multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.findType`\n '
pass
|
The findTypecommand is used to search through a dependency subgraph on a certain node to find all nodes of the given
type. The search can go either upstream (input connections) or downstream (output connections). The plug/attribute
dependencies are not taken into account when searching for matching nodes, only the connections.
Flags:
- deep : d (bool) [create]
Find all nodes of the given type instead of just the first.
- exact : e (bool) [create]
Match node types exactly instead of any in a node hierarchy.
- forward : f (bool) [create]
Look forwards (downstream) through the graph rather than backwards (upstream) for matching nodes.
- type : t (unicode) [create]
Type of node to look for (e.g. transform). This flag is mandatory. Flag can have
multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.findType`
|
mayaSDK/pymel/core/system.py
|
findType
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def findType(*args, **kwargs):
'\n The findTypecommand is used to search through a dependency subgraph on a certain node to find all nodes of the given\n type. The search can go either upstream (input connections) or downstream (output connections). The plug/attribute\n dependencies are not taken into account when searching for matching nodes, only the connections.\n \n Flags:\n - deep : d (bool) [create]\n Find all nodes of the given type instead of just the first.\n \n - exact : e (bool) [create]\n Match node types exactly instead of any in a node hierarchy.\n \n - forward : f (bool) [create]\n Look forwards (downstream) through the graph rather than backwards (upstream) for matching nodes.\n \n - type : t (unicode) [create]\n Type of node to look for (e.g. transform). This flag is mandatory. Flag can have\n multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.findType`\n '
pass
|
def findType(*args, **kwargs):
'\n The findTypecommand is used to search through a dependency subgraph on a certain node to find all nodes of the given\n type. The search can go either upstream (input connections) or downstream (output connections). The plug/attribute\n dependencies are not taken into account when searching for matching nodes, only the connections.\n \n Flags:\n - deep : d (bool) [create]\n Find all nodes of the given type instead of just the first.\n \n - exact : e (bool) [create]\n Match node types exactly instead of any in a node hierarchy.\n \n - forward : f (bool) [create]\n Look forwards (downstream) through the graph rather than backwards (upstream) for matching nodes.\n \n - type : t (unicode) [create]\n Type of node to look for (e.g. transform). This flag is mandatory. Flag can have\n multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.findType`\n '
pass<|docstring|>The findTypecommand is used to search through a dependency subgraph on a certain node to find all nodes of the given
type. The search can go either upstream (input connections) or downstream (output connections). The plug/attribute
dependencies are not taken into account when searching for matching nodes, only the connections.
Flags:
- deep : d (bool) [create]
Find all nodes of the given type instead of just the first.
- exact : e (bool) [create]
Match node types exactly instead of any in a node hierarchy.
- forward : f (bool) [create]
Look forwards (downstream) through the graph rather than backwards (upstream) for matching nodes.
- type : t (unicode) [create]
Type of node to look for (e.g. transform). This flag is mandatory. Flag can have
multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.findType`<|endoftext|>
|
a343b445a8a6f313baad420f1ff09c60f33db329060811ba2a40a49cb0cdbd8a
|
def referenceQuery(*args, **kwargs):
"\n Use this command to find out information about references and referenced nodes. A valid target is either a reference\n node, a reference file, or a referenced node. Some flags don't require a target, see flag descriptions for more\n information on what effect this has. When a scene contains multiple levels of file references, those edits which affect\n a nested reference may be stored on several different reference nodes. For example: A.ma has a reference to B.ma which\n has a reference to C.ma which contains a poly sphere (pSphere1). If you were to open B.ma and translate the sphere, an\n edit would be stored on CRN which refers to a node named C:pSphere1. If you were then to open A.ma and parent the\n sphere, an edit would be stored on BRN which refers to a node named B:C:pSphere1. It is important to note that when\n querying edits which affect a nested reference, the edits will be returned in the same format that they were applied. In\n the above example, opening A.ma and querying all edits which affect C.ma, would return two edits a parent edit affecting\n B:C:pSphere1, and a setAttr edit affecting C:pSphere1. Since there is currently no node named C:pSphere1 (only\n B:C:pSphere1) care will have to be taken when interpreting the returned information. The same care should be taken when\n referenced DAG nodes have been parented or instanced. Continuing with the previous example, let's say that you were to\n open A.ma and, instead of simply parenting pSphere1, you were to instance it. While A.ma is open, B:C:pSphere1may now be\n an amibiguous name, replaced by |B:C:pSphere1and group1|B:C:pSphere1. However querying the edits which affect C.ma would\n still return a setAttr edit affecting C:pSphere1since it was applied prior to B:C:pSphere1 being instanced. Some tips:\n 1. Use the '-topReference' flag to query only those edits which were applied from the currently open file. 2. Use the\n '-onReferenceNode' flag to limit the results to those edits where are stored on a given reference node. You can then\n use various string manipulation techniques to extrapolate the current name of any affected nodes.\n \n Modifications:\n - When queried for 'es/editStrings', returned a list of ReferenceEdit objects\n - By default, returns all edits. If neither of successfulEdits or\n failedEdits is given, they both default to True. If only one is given,\n the other defaults to the opposite value.\n \n Flags:\n - child : ch (bool) [create]\n This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the children of the target\n reference will be returned. Returns a string array.\n \n - dagPath : dp (bool) [create]\n This flag modifies the '-n/-nodes' flag to indicate that the names of any dag objects returned will include as much of\n the dag path as is necessary to make the names unique. If this flag is not present, the names returned will not include\n any dag paths.\n \n - editAttrs : ea (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the\n attributes involved in the reference edit will be returned. If an edit involves multiple attributes (e.g.\n connectAttredits) the nodes will be returned as separate, consecutive entries in the string array. A valid target is\n either a reference node, a reference file, or a referenced node. If a referenced node is specified, only those edits\n which affect that node will be returned. If a reference file or reference node is specified any edit which affects a\n node in that reference will be returned. If no target is specified all edits are returned. This command can be used on\n both loaded and unloaded references. By default it will return all the edits, formatted as MEL commands, which apply to\n the target. This flag can be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the\n involved nodes and attributes will be returned in the format 'node.attribute'.\n \n - editCommand : ec (unicode) [create,query]\n This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this\n flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,\n connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified\n more than once to specify multiple edit types to consider.\n \n - editNodes : en (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the\n nodes involved in the reference edit will be returned. If an edit involves multiple nodes (e.g. connectAttredits) the\n nodes will be returned as separate, consecutive entries in the string array. A valid target is either a reference node,\n a reference file, or a referenced node. If a referenced node is specified, only those edits which affect that node will\n be returned. If a reference file or reference node is specified any edit which affects a node in that reference will be\n returned. If no target is specified all edits are returned. This command can be used on both loaded and unloaded\n references. By default it will return all the edits, formatted as MEL commands, which apply to the target. This flag can\n be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the involved nodes and\n attributes will be returned in the format 'node.attribute'.\n \n - editStrings : es (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. The edit will be\n returned as a valid MEL command. A valid target is either a reference node, a reference file, or a referenced node. If a\n referenced node is specified, only those edits which affect that node will be returned. If a reference file or reference\n node is specified any edit which affects a node in that reference will be returned. If no target is specified all edits\n are returned. This command can be used on both loaded and unloaded references. By default it will return all the edits,\n formatted as MEL commands, which apply to the target. This flag cannot be used with either the '-en/-editNodes' or\n '-ea/-editAttrs' flags.\n \n - failedEdits : fld (bool) [create]\n This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,\n etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An\n edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced\n file). By default failed edits will not be acted on.\n \n - filename : f (bool) [create]\n Returns string. A main flag used to query the filename associated with the target reference.\n \n - isExportEdits : iee (bool) [create]\n Returns a boolean indicating whether the specified reference node or file name is an edits file (created with the Export\n Edits feature)\n \n - isLoaded : il (bool) [create]\n Returns a boolean indicating whether the specified reference node or file name refers to a loaded or unloaded reference.\n \n - isNodeReferenced : inr (bool) [create]\n Returns boolean. A main flag used to determine whether or not the target node comes from a referenced file. true if the\n target node comes from a referenced file, false if not.\n \n - isPreviewOnly : ipo (bool) [create]\n Returns boolean. This flag is used to determine whether or not the target reference node is only a preview reference\n node.\n \n - liveEdits : le (bool) [create]\n Specifies that the edits should be returned based on the live edits database. Only valid when used in conjunction with\n the editStrings flag.\n \n - namespace : ns (bool) [create]\n Returns string. This flag returns the full namespace path of the target reference, starting from the root namespace :.\n It can be combined with the shortName flag to return just the base name of the namespace.\n \n - nodes : n (bool) [create]\n Returns string array. A main flag used to query the contents of the target reference.\n \n - onReferenceNode : orn (unicode) [create,query]\n This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should\n be considered. This flag only supports multiple uses when specified with the exportEditscommand.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n - parent : p (bool) [create]\n This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the parent of the target reference\n will be returned.\n \n - parentNamespace : pns (bool) [create]\n A main flag used to query and return the parent namespace of the target reference.\n \n - referenceNode : rfn (bool) [create]\n Returns string. A main flag used to query the reference node associated with the target reference.\n \n - shortName : shn (bool) [create]\n This flag modifies the '-f/-filename' and '-ns/-namespace' flags. Used with the '-f/-filename' flag indicates that the\n file name returned will be the short name (i.e. just a file name without any directory paths). If this flag is not\n present, the full name and directory path will be returned. Used with the '-ns/-namespace' flag indicates that the\n namespace returned will be the base name of the namespace. (i.e. the base name of the full namespace path :AAA:BBB:CCCis\n CCC\n \n - showDagPath : sdp (bool) [create]\n Shows/hides the full dag path for edits. If false only displays the node-name of reference edits. Must be used with the\n -editNodes, -editStrings or -editAttrs flag.\n \n - showNamespace : sns (bool) [create]\n Shows/hides the namespaces on nodes in the reference edits. Must be used with the -editNodes, -editStrings or -editAttrs\n flag\n \n - successfulEdits : scs (bool) [create]\n This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,\n etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. By default\n successful edits will be acted on.\n \n - topReference : tr (bool) [create]\n This flag modifies the '-rfn/-referenceNode' flag to indicate the top level ancestral reference of the target reference\n will be returned.\n \n - unresolvedName : un (bool) [create]\n This flag modifies the '-f/-filename' flag to indicate that the file name returned will be unresolved (i.e. it will be\n the path originally specified when the file was loaded into Maya; this path may contain environment variables and may\n not exist on disk). If this flag is not present, the resolved name will be returned.\n \n - withoutCopyNumber : wcn (bool) [create]\n This flag modifies the '-f/-filename' flag to indicate that the file name returned will not have a copy number (e.g.\n '{1}') appended to the end. If this flag is not present, the file name returned may have a copy number appended to the\n end.\n \n \n Derived from mel command `maya.cmds.referenceQuery`\n "
pass
|
Use this command to find out information about references and referenced nodes. A valid target is either a reference
node, a reference file, or a referenced node. Some flags don't require a target, see flag descriptions for more
information on what effect this has. When a scene contains multiple levels of file references, those edits which affect
a nested reference may be stored on several different reference nodes. For example: A.ma has a reference to B.ma which
has a reference to C.ma which contains a poly sphere (pSphere1). If you were to open B.ma and translate the sphere, an
edit would be stored on CRN which refers to a node named C:pSphere1. If you were then to open A.ma and parent the
sphere, an edit would be stored on BRN which refers to a node named B:C:pSphere1. It is important to note that when
querying edits which affect a nested reference, the edits will be returned in the same format that they were applied. In
the above example, opening A.ma and querying all edits which affect C.ma, would return two edits a parent edit affecting
B:C:pSphere1, and a setAttr edit affecting C:pSphere1. Since there is currently no node named C:pSphere1 (only
B:C:pSphere1) care will have to be taken when interpreting the returned information. The same care should be taken when
referenced DAG nodes have been parented or instanced. Continuing with the previous example, let's say that you were to
open A.ma and, instead of simply parenting pSphere1, you were to instance it. While A.ma is open, B:C:pSphere1may now be
an amibiguous name, replaced by |B:C:pSphere1and group1|B:C:pSphere1. However querying the edits which affect C.ma would
still return a setAttr edit affecting C:pSphere1since it was applied prior to B:C:pSphere1 being instanced. Some tips:
1. Use the '-topReference' flag to query only those edits which were applied from the currently open file. 2. Use the
'-onReferenceNode' flag to limit the results to those edits where are stored on a given reference node. You can then
use various string manipulation techniques to extrapolate the current name of any affected nodes.
Modifications:
- When queried for 'es/editStrings', returned a list of ReferenceEdit objects
- By default, returns all edits. If neither of successfulEdits or
failedEdits is given, they both default to True. If only one is given,
the other defaults to the opposite value.
Flags:
- child : ch (bool) [create]
This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the children of the target
reference will be returned. Returns a string array.
- dagPath : dp (bool) [create]
This flag modifies the '-n/-nodes' flag to indicate that the names of any dag objects returned will include as much of
the dag path as is necessary to make the names unique. If this flag is not present, the names returned will not include
any dag paths.
- editAttrs : ea (bool) [create]
Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the
attributes involved in the reference edit will be returned. If an edit involves multiple attributes (e.g.
connectAttredits) the nodes will be returned as separate, consecutive entries in the string array. A valid target is
either a reference node, a reference file, or a referenced node. If a referenced node is specified, only those edits
which affect that node will be returned. If a reference file or reference node is specified any edit which affects a
node in that reference will be returned. If no target is specified all edits are returned. This command can be used on
both loaded and unloaded references. By default it will return all the edits, formatted as MEL commands, which apply to
the target. This flag can be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the
involved nodes and attributes will be returned in the format 'node.attribute'.
- editCommand : ec (unicode) [create,query]
This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this
flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,
connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified
more than once to specify multiple edit types to consider.
- editNodes : en (bool) [create]
Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the
nodes involved in the reference edit will be returned. If an edit involves multiple nodes (e.g. connectAttredits) the
nodes will be returned as separate, consecutive entries in the string array. A valid target is either a reference node,
a reference file, or a referenced node. If a referenced node is specified, only those edits which affect that node will
be returned. If a reference file or reference node is specified any edit which affects a node in that reference will be
returned. If no target is specified all edits are returned. This command can be used on both loaded and unloaded
references. By default it will return all the edits, formatted as MEL commands, which apply to the target. This flag can
be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the involved nodes and
attributes will be returned in the format 'node.attribute'.
- editStrings : es (bool) [create]
Returns string array. A main flag used to query the edits that have been applied to the target. The edit will be
returned as a valid MEL command. A valid target is either a reference node, a reference file, or a referenced node. If a
referenced node is specified, only those edits which affect that node will be returned. If a reference file or reference
node is specified any edit which affects a node in that reference will be returned. If no target is specified all edits
are returned. This command can be used on both loaded and unloaded references. By default it will return all the edits,
formatted as MEL commands, which apply to the target. This flag cannot be used with either the '-en/-editNodes' or
'-ea/-editAttrs' flags.
- failedEdits : fld (bool) [create]
This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,
etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An
edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced
file). By default failed edits will not be acted on.
- filename : f (bool) [create]
Returns string. A main flag used to query the filename associated with the target reference.
- isExportEdits : iee (bool) [create]
Returns a boolean indicating whether the specified reference node or file name is an edits file (created with the Export
Edits feature)
- isLoaded : il (bool) [create]
Returns a boolean indicating whether the specified reference node or file name refers to a loaded or unloaded reference.
- isNodeReferenced : inr (bool) [create]
Returns boolean. A main flag used to determine whether or not the target node comes from a referenced file. true if the
target node comes from a referenced file, false if not.
- isPreviewOnly : ipo (bool) [create]
Returns boolean. This flag is used to determine whether or not the target reference node is only a preview reference
node.
- liveEdits : le (bool) [create]
Specifies that the edits should be returned based on the live edits database. Only valid when used in conjunction with
the editStrings flag.
- namespace : ns (bool) [create]
Returns string. This flag returns the full namespace path of the target reference, starting from the root namespace :.
It can be combined with the shortName flag to return just the base name of the namespace.
- nodes : n (bool) [create]
Returns string array. A main flag used to query the contents of the target reference.
- onReferenceNode : orn (unicode) [create,query]
This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should
be considered. This flag only supports multiple uses when specified with the exportEditscommand.
Flag can have multiple arguments, passed either as a tuple or a list.
- parent : p (bool) [create]
This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the parent of the target reference
will be returned.
- parentNamespace : pns (bool) [create]
A main flag used to query and return the parent namespace of the target reference.
- referenceNode : rfn (bool) [create]
Returns string. A main flag used to query the reference node associated with the target reference.
- shortName : shn (bool) [create]
This flag modifies the '-f/-filename' and '-ns/-namespace' flags. Used with the '-f/-filename' flag indicates that the
file name returned will be the short name (i.e. just a file name without any directory paths). If this flag is not
present, the full name and directory path will be returned. Used with the '-ns/-namespace' flag indicates that the
namespace returned will be the base name of the namespace. (i.e. the base name of the full namespace path :AAA:BBB:CCCis
CCC
- showDagPath : sdp (bool) [create]
Shows/hides the full dag path for edits. If false only displays the node-name of reference edits. Must be used with the
-editNodes, -editStrings or -editAttrs flag.
- showNamespace : sns (bool) [create]
Shows/hides the namespaces on nodes in the reference edits. Must be used with the -editNodes, -editStrings or -editAttrs
flag
- successfulEdits : scs (bool) [create]
This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,
etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. By default
successful edits will be acted on.
- topReference : tr (bool) [create]
This flag modifies the '-rfn/-referenceNode' flag to indicate the top level ancestral reference of the target reference
will be returned.
- unresolvedName : un (bool) [create]
This flag modifies the '-f/-filename' flag to indicate that the file name returned will be unresolved (i.e. it will be
the path originally specified when the file was loaded into Maya; this path may contain environment variables and may
not exist on disk). If this flag is not present, the resolved name will be returned.
- withoutCopyNumber : wcn (bool) [create]
This flag modifies the '-f/-filename' flag to indicate that the file name returned will not have a copy number (e.g.
'{1}') appended to the end. If this flag is not present, the file name returned may have a copy number appended to the
end.
Derived from mel command `maya.cmds.referenceQuery`
|
mayaSDK/pymel/core/system.py
|
referenceQuery
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def referenceQuery(*args, **kwargs):
"\n Use this command to find out information about references and referenced nodes. A valid target is either a reference\n node, a reference file, or a referenced node. Some flags don't require a target, see flag descriptions for more\n information on what effect this has. When a scene contains multiple levels of file references, those edits which affect\n a nested reference may be stored on several different reference nodes. For example: A.ma has a reference to B.ma which\n has a reference to C.ma which contains a poly sphere (pSphere1). If you were to open B.ma and translate the sphere, an\n edit would be stored on CRN which refers to a node named C:pSphere1. If you were then to open A.ma and parent the\n sphere, an edit would be stored on BRN which refers to a node named B:C:pSphere1. It is important to note that when\n querying edits which affect a nested reference, the edits will be returned in the same format that they were applied. In\n the above example, opening A.ma and querying all edits which affect C.ma, would return two edits a parent edit affecting\n B:C:pSphere1, and a setAttr edit affecting C:pSphere1. Since there is currently no node named C:pSphere1 (only\n B:C:pSphere1) care will have to be taken when interpreting the returned information. The same care should be taken when\n referenced DAG nodes have been parented or instanced. Continuing with the previous example, let's say that you were to\n open A.ma and, instead of simply parenting pSphere1, you were to instance it. While A.ma is open, B:C:pSphere1may now be\n an amibiguous name, replaced by |B:C:pSphere1and group1|B:C:pSphere1. However querying the edits which affect C.ma would\n still return a setAttr edit affecting C:pSphere1since it was applied prior to B:C:pSphere1 being instanced. Some tips:\n 1. Use the '-topReference' flag to query only those edits which were applied from the currently open file. 2. Use the\n '-onReferenceNode' flag to limit the results to those edits where are stored on a given reference node. You can then\n use various string manipulation techniques to extrapolate the current name of any affected nodes.\n \n Modifications:\n - When queried for 'es/editStrings', returned a list of ReferenceEdit objects\n - By default, returns all edits. If neither of successfulEdits or\n failedEdits is given, they both default to True. If only one is given,\n the other defaults to the opposite value.\n \n Flags:\n - child : ch (bool) [create]\n This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the children of the target\n reference will be returned. Returns a string array.\n \n - dagPath : dp (bool) [create]\n This flag modifies the '-n/-nodes' flag to indicate that the names of any dag objects returned will include as much of\n the dag path as is necessary to make the names unique. If this flag is not present, the names returned will not include\n any dag paths.\n \n - editAttrs : ea (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the\n attributes involved in the reference edit will be returned. If an edit involves multiple attributes (e.g.\n connectAttredits) the nodes will be returned as separate, consecutive entries in the string array. A valid target is\n either a reference node, a reference file, or a referenced node. If a referenced node is specified, only those edits\n which affect that node will be returned. If a reference file or reference node is specified any edit which affects a\n node in that reference will be returned. If no target is specified all edits are returned. This command can be used on\n both loaded and unloaded references. By default it will return all the edits, formatted as MEL commands, which apply to\n the target. This flag can be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the\n involved nodes and attributes will be returned in the format 'node.attribute'.\n \n - editCommand : ec (unicode) [create,query]\n This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this\n flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,\n connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified\n more than once to specify multiple edit types to consider.\n \n - editNodes : en (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the\n nodes involved in the reference edit will be returned. If an edit involves multiple nodes (e.g. connectAttredits) the\n nodes will be returned as separate, consecutive entries in the string array. A valid target is either a reference node,\n a reference file, or a referenced node. If a referenced node is specified, only those edits which affect that node will\n be returned. If a reference file or reference node is specified any edit which affects a node in that reference will be\n returned. If no target is specified all edits are returned. This command can be used on both loaded and unloaded\n references. By default it will return all the edits, formatted as MEL commands, which apply to the target. This flag can\n be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the involved nodes and\n attributes will be returned in the format 'node.attribute'.\n \n - editStrings : es (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. The edit will be\n returned as a valid MEL command. A valid target is either a reference node, a reference file, or a referenced node. If a\n referenced node is specified, only those edits which affect that node will be returned. If a reference file or reference\n node is specified any edit which affects a node in that reference will be returned. If no target is specified all edits\n are returned. This command can be used on both loaded and unloaded references. By default it will return all the edits,\n formatted as MEL commands, which apply to the target. This flag cannot be used with either the '-en/-editNodes' or\n '-ea/-editAttrs' flags.\n \n - failedEdits : fld (bool) [create]\n This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,\n etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An\n edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced\n file). By default failed edits will not be acted on.\n \n - filename : f (bool) [create]\n Returns string. A main flag used to query the filename associated with the target reference.\n \n - isExportEdits : iee (bool) [create]\n Returns a boolean indicating whether the specified reference node or file name is an edits file (created with the Export\n Edits feature)\n \n - isLoaded : il (bool) [create]\n Returns a boolean indicating whether the specified reference node or file name refers to a loaded or unloaded reference.\n \n - isNodeReferenced : inr (bool) [create]\n Returns boolean. A main flag used to determine whether or not the target node comes from a referenced file. true if the\n target node comes from a referenced file, false if not.\n \n - isPreviewOnly : ipo (bool) [create]\n Returns boolean. This flag is used to determine whether or not the target reference node is only a preview reference\n node.\n \n - liveEdits : le (bool) [create]\n Specifies that the edits should be returned based on the live edits database. Only valid when used in conjunction with\n the editStrings flag.\n \n - namespace : ns (bool) [create]\n Returns string. This flag returns the full namespace path of the target reference, starting from the root namespace :.\n It can be combined with the shortName flag to return just the base name of the namespace.\n \n - nodes : n (bool) [create]\n Returns string array. A main flag used to query the contents of the target reference.\n \n - onReferenceNode : orn (unicode) [create,query]\n This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should\n be considered. This flag only supports multiple uses when specified with the exportEditscommand.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n - parent : p (bool) [create]\n This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the parent of the target reference\n will be returned.\n \n - parentNamespace : pns (bool) [create]\n A main flag used to query and return the parent namespace of the target reference.\n \n - referenceNode : rfn (bool) [create]\n Returns string. A main flag used to query the reference node associated with the target reference.\n \n - shortName : shn (bool) [create]\n This flag modifies the '-f/-filename' and '-ns/-namespace' flags. Used with the '-f/-filename' flag indicates that the\n file name returned will be the short name (i.e. just a file name without any directory paths). If this flag is not\n present, the full name and directory path will be returned. Used with the '-ns/-namespace' flag indicates that the\n namespace returned will be the base name of the namespace. (i.e. the base name of the full namespace path :AAA:BBB:CCCis\n CCC\n \n - showDagPath : sdp (bool) [create]\n Shows/hides the full dag path for edits. If false only displays the node-name of reference edits. Must be used with the\n -editNodes, -editStrings or -editAttrs flag.\n \n - showNamespace : sns (bool) [create]\n Shows/hides the namespaces on nodes in the reference edits. Must be used with the -editNodes, -editStrings or -editAttrs\n flag\n \n - successfulEdits : scs (bool) [create]\n This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,\n etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. By default\n successful edits will be acted on.\n \n - topReference : tr (bool) [create]\n This flag modifies the '-rfn/-referenceNode' flag to indicate the top level ancestral reference of the target reference\n will be returned.\n \n - unresolvedName : un (bool) [create]\n This flag modifies the '-f/-filename' flag to indicate that the file name returned will be unresolved (i.e. it will be\n the path originally specified when the file was loaded into Maya; this path may contain environment variables and may\n not exist on disk). If this flag is not present, the resolved name will be returned.\n \n - withoutCopyNumber : wcn (bool) [create]\n This flag modifies the '-f/-filename' flag to indicate that the file name returned will not have a copy number (e.g.\n '{1}') appended to the end. If this flag is not present, the file name returned may have a copy number appended to the\n end.\n \n \n Derived from mel command `maya.cmds.referenceQuery`\n "
pass
|
def referenceQuery(*args, **kwargs):
"\n Use this command to find out information about references and referenced nodes. A valid target is either a reference\n node, a reference file, or a referenced node. Some flags don't require a target, see flag descriptions for more\n information on what effect this has. When a scene contains multiple levels of file references, those edits which affect\n a nested reference may be stored on several different reference nodes. For example: A.ma has a reference to B.ma which\n has a reference to C.ma which contains a poly sphere (pSphere1). If you were to open B.ma and translate the sphere, an\n edit would be stored on CRN which refers to a node named C:pSphere1. If you were then to open A.ma and parent the\n sphere, an edit would be stored on BRN which refers to a node named B:C:pSphere1. It is important to note that when\n querying edits which affect a nested reference, the edits will be returned in the same format that they were applied. In\n the above example, opening A.ma and querying all edits which affect C.ma, would return two edits a parent edit affecting\n B:C:pSphere1, and a setAttr edit affecting C:pSphere1. Since there is currently no node named C:pSphere1 (only\n B:C:pSphere1) care will have to be taken when interpreting the returned information. The same care should be taken when\n referenced DAG nodes have been parented or instanced. Continuing with the previous example, let's say that you were to\n open A.ma and, instead of simply parenting pSphere1, you were to instance it. While A.ma is open, B:C:pSphere1may now be\n an amibiguous name, replaced by |B:C:pSphere1and group1|B:C:pSphere1. However querying the edits which affect C.ma would\n still return a setAttr edit affecting C:pSphere1since it was applied prior to B:C:pSphere1 being instanced. Some tips:\n 1. Use the '-topReference' flag to query only those edits which were applied from the currently open file. 2. Use the\n '-onReferenceNode' flag to limit the results to those edits where are stored on a given reference node. You can then\n use various string manipulation techniques to extrapolate the current name of any affected nodes.\n \n Modifications:\n - When queried for 'es/editStrings', returned a list of ReferenceEdit objects\n - By default, returns all edits. If neither of successfulEdits or\n failedEdits is given, they both default to True. If only one is given,\n the other defaults to the opposite value.\n \n Flags:\n - child : ch (bool) [create]\n This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the children of the target\n reference will be returned. Returns a string array.\n \n - dagPath : dp (bool) [create]\n This flag modifies the '-n/-nodes' flag to indicate that the names of any dag objects returned will include as much of\n the dag path as is necessary to make the names unique. If this flag is not present, the names returned will not include\n any dag paths.\n \n - editAttrs : ea (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the\n attributes involved in the reference edit will be returned. If an edit involves multiple attributes (e.g.\n connectAttredits) the nodes will be returned as separate, consecutive entries in the string array. A valid target is\n either a reference node, a reference file, or a referenced node. If a referenced node is specified, only those edits\n which affect that node will be returned. If a reference file or reference node is specified any edit which affects a\n node in that reference will be returned. If no target is specified all edits are returned. This command can be used on\n both loaded and unloaded references. By default it will return all the edits, formatted as MEL commands, which apply to\n the target. This flag can be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the\n involved nodes and attributes will be returned in the format 'node.attribute'.\n \n - editCommand : ec (unicode) [create,query]\n This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this\n flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,\n connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified\n more than once to specify multiple edit types to consider.\n \n - editNodes : en (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the\n nodes involved in the reference edit will be returned. If an edit involves multiple nodes (e.g. connectAttredits) the\n nodes will be returned as separate, consecutive entries in the string array. A valid target is either a reference node,\n a reference file, or a referenced node. If a referenced node is specified, only those edits which affect that node will\n be returned. If a reference file or reference node is specified any edit which affects a node in that reference will be\n returned. If no target is specified all edits are returned. This command can be used on both loaded and unloaded\n references. By default it will return all the edits, formatted as MEL commands, which apply to the target. This flag can\n be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the involved nodes and\n attributes will be returned in the format 'node.attribute'.\n \n - editStrings : es (bool) [create]\n Returns string array. A main flag used to query the edits that have been applied to the target. The edit will be\n returned as a valid MEL command. A valid target is either a reference node, a reference file, or a referenced node. If a\n referenced node is specified, only those edits which affect that node will be returned. If a reference file or reference\n node is specified any edit which affects a node in that reference will be returned. If no target is specified all edits\n are returned. This command can be used on both loaded and unloaded references. By default it will return all the edits,\n formatted as MEL commands, which apply to the target. This flag cannot be used with either the '-en/-editNodes' or\n '-ea/-editAttrs' flags.\n \n - failedEdits : fld (bool) [create]\n This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,\n etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An\n edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced\n file). By default failed edits will not be acted on.\n \n - filename : f (bool) [create]\n Returns string. A main flag used to query the filename associated with the target reference.\n \n - isExportEdits : iee (bool) [create]\n Returns a boolean indicating whether the specified reference node or file name is an edits file (created with the Export\n Edits feature)\n \n - isLoaded : il (bool) [create]\n Returns a boolean indicating whether the specified reference node or file name refers to a loaded or unloaded reference.\n \n - isNodeReferenced : inr (bool) [create]\n Returns boolean. A main flag used to determine whether or not the target node comes from a referenced file. true if the\n target node comes from a referenced file, false if not.\n \n - isPreviewOnly : ipo (bool) [create]\n Returns boolean. This flag is used to determine whether or not the target reference node is only a preview reference\n node.\n \n - liveEdits : le (bool) [create]\n Specifies that the edits should be returned based on the live edits database. Only valid when used in conjunction with\n the editStrings flag.\n \n - namespace : ns (bool) [create]\n Returns string. This flag returns the full namespace path of the target reference, starting from the root namespace :.\n It can be combined with the shortName flag to return just the base name of the namespace.\n \n - nodes : n (bool) [create]\n Returns string array. A main flag used to query the contents of the target reference.\n \n - onReferenceNode : orn (unicode) [create,query]\n This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should\n be considered. This flag only supports multiple uses when specified with the exportEditscommand.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n - parent : p (bool) [create]\n This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the parent of the target reference\n will be returned.\n \n - parentNamespace : pns (bool) [create]\n A main flag used to query and return the parent namespace of the target reference.\n \n - referenceNode : rfn (bool) [create]\n Returns string. A main flag used to query the reference node associated with the target reference.\n \n - shortName : shn (bool) [create]\n This flag modifies the '-f/-filename' and '-ns/-namespace' flags. Used with the '-f/-filename' flag indicates that the\n file name returned will be the short name (i.e. just a file name without any directory paths). If this flag is not\n present, the full name and directory path will be returned. Used with the '-ns/-namespace' flag indicates that the\n namespace returned will be the base name of the namespace. (i.e. the base name of the full namespace path :AAA:BBB:CCCis\n CCC\n \n - showDagPath : sdp (bool) [create]\n Shows/hides the full dag path for edits. If false only displays the node-name of reference edits. Must be used with the\n -editNodes, -editStrings or -editAttrs flag.\n \n - showNamespace : sns (bool) [create]\n Shows/hides the namespaces on nodes in the reference edits. Must be used with the -editNodes, -editStrings or -editAttrs\n flag\n \n - successfulEdits : scs (bool) [create]\n This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,\n etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. By default\n successful edits will be acted on.\n \n - topReference : tr (bool) [create]\n This flag modifies the '-rfn/-referenceNode' flag to indicate the top level ancestral reference of the target reference\n will be returned.\n \n - unresolvedName : un (bool) [create]\n This flag modifies the '-f/-filename' flag to indicate that the file name returned will be unresolved (i.e. it will be\n the path originally specified when the file was loaded into Maya; this path may contain environment variables and may\n not exist on disk). If this flag is not present, the resolved name will be returned.\n \n - withoutCopyNumber : wcn (bool) [create]\n This flag modifies the '-f/-filename' flag to indicate that the file name returned will not have a copy number (e.g.\n '{1}') appended to the end. If this flag is not present, the file name returned may have a copy number appended to the\n end.\n \n \n Derived from mel command `maya.cmds.referenceQuery`\n "
pass<|docstring|>Use this command to find out information about references and referenced nodes. A valid target is either a reference
node, a reference file, or a referenced node. Some flags don't require a target, see flag descriptions for more
information on what effect this has. When a scene contains multiple levels of file references, those edits which affect
a nested reference may be stored on several different reference nodes. For example: A.ma has a reference to B.ma which
has a reference to C.ma which contains a poly sphere (pSphere1). If you were to open B.ma and translate the sphere, an
edit would be stored on CRN which refers to a node named C:pSphere1. If you were then to open A.ma and parent the
sphere, an edit would be stored on BRN which refers to a node named B:C:pSphere1. It is important to note that when
querying edits which affect a nested reference, the edits will be returned in the same format that they were applied. In
the above example, opening A.ma and querying all edits which affect C.ma, would return two edits a parent edit affecting
B:C:pSphere1, and a setAttr edit affecting C:pSphere1. Since there is currently no node named C:pSphere1 (only
B:C:pSphere1) care will have to be taken when interpreting the returned information. The same care should be taken when
referenced DAG nodes have been parented or instanced. Continuing with the previous example, let's say that you were to
open A.ma and, instead of simply parenting pSphere1, you were to instance it. While A.ma is open, B:C:pSphere1may now be
an amibiguous name, replaced by |B:C:pSphere1and group1|B:C:pSphere1. However querying the edits which affect C.ma would
still return a setAttr edit affecting C:pSphere1since it was applied prior to B:C:pSphere1 being instanced. Some tips:
1. Use the '-topReference' flag to query only those edits which were applied from the currently open file. 2. Use the
'-onReferenceNode' flag to limit the results to those edits where are stored on a given reference node. You can then
use various string manipulation techniques to extrapolate the current name of any affected nodes.
Modifications:
- When queried for 'es/editStrings', returned a list of ReferenceEdit objects
- By default, returns all edits. If neither of successfulEdits or
failedEdits is given, they both default to True. If only one is given,
the other defaults to the opposite value.
Flags:
- child : ch (bool) [create]
This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the children of the target
reference will be returned. Returns a string array.
- dagPath : dp (bool) [create]
This flag modifies the '-n/-nodes' flag to indicate that the names of any dag objects returned will include as much of
the dag path as is necessary to make the names unique. If this flag is not present, the names returned will not include
any dag paths.
- editAttrs : ea (bool) [create]
Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the
attributes involved in the reference edit will be returned. If an edit involves multiple attributes (e.g.
connectAttredits) the nodes will be returned as separate, consecutive entries in the string array. A valid target is
either a reference node, a reference file, or a referenced node. If a referenced node is specified, only those edits
which affect that node will be returned. If a reference file or reference node is specified any edit which affects a
node in that reference will be returned. If no target is specified all edits are returned. This command can be used on
both loaded and unloaded references. By default it will return all the edits, formatted as MEL commands, which apply to
the target. This flag can be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the
involved nodes and attributes will be returned in the format 'node.attribute'.
- editCommand : ec (unicode) [create,query]
This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this
flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,
connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified
more than once to specify multiple edit types to consider.
- editNodes : en (bool) [create]
Returns string array. A main flag used to query the edits that have been applied to the target. Only the names of the
nodes involved in the reference edit will be returned. If an edit involves multiple nodes (e.g. connectAttredits) the
nodes will be returned as separate, consecutive entries in the string array. A valid target is either a reference node,
a reference file, or a referenced node. If a referenced node is specified, only those edits which affect that node will
be returned. If a reference file or reference node is specified any edit which affects a node in that reference will be
returned. If no target is specified all edits are returned. This command can be used on both loaded and unloaded
references. By default it will return all the edits, formatted as MEL commands, which apply to the target. This flag can
be used in combination with the '-ea/-editAttrs' flag to indicate that the names of both the involved nodes and
attributes will be returned in the format 'node.attribute'.
- editStrings : es (bool) [create]
Returns string array. A main flag used to query the edits that have been applied to the target. The edit will be
returned as a valid MEL command. A valid target is either a reference node, a reference file, or a referenced node. If a
referenced node is specified, only those edits which affect that node will be returned. If a reference file or reference
node is specified any edit which affects a node in that reference will be returned. If no target is specified all edits
are returned. This command can be used on both loaded and unloaded references. By default it will return all the edits,
formatted as MEL commands, which apply to the target. This flag cannot be used with either the '-en/-editNodes' or
'-ea/-editAttrs' flags.
- failedEdits : fld (bool) [create]
This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,
etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An
edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced
file). By default failed edits will not be acted on.
- filename : f (bool) [create]
Returns string. A main flag used to query the filename associated with the target reference.
- isExportEdits : iee (bool) [create]
Returns a boolean indicating whether the specified reference node or file name is an edits file (created with the Export
Edits feature)
- isLoaded : il (bool) [create]
Returns a boolean indicating whether the specified reference node or file name refers to a loaded or unloaded reference.
- isNodeReferenced : inr (bool) [create]
Returns boolean. A main flag used to determine whether or not the target node comes from a referenced file. true if the
target node comes from a referenced file, false if not.
- isPreviewOnly : ipo (bool) [create]
Returns boolean. This flag is used to determine whether or not the target reference node is only a preview reference
node.
- liveEdits : le (bool) [create]
Specifies that the edits should be returned based on the live edits database. Only valid when used in conjunction with
the editStrings flag.
- namespace : ns (bool) [create]
Returns string. This flag returns the full namespace path of the target reference, starting from the root namespace :.
It can be combined with the shortName flag to return just the base name of the namespace.
- nodes : n (bool) [create]
Returns string array. A main flag used to query the contents of the target reference.
- onReferenceNode : orn (unicode) [create,query]
This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should
be considered. This flag only supports multiple uses when specified with the exportEditscommand.
Flag can have multiple arguments, passed either as a tuple or a list.
- parent : p (bool) [create]
This flag modifies the '-rfn/-referenceNode' and '-f/-filename' flags to indicate the the parent of the target reference
will be returned.
- parentNamespace : pns (bool) [create]
A main flag used to query and return the parent namespace of the target reference.
- referenceNode : rfn (bool) [create]
Returns string. A main flag used to query the reference node associated with the target reference.
- shortName : shn (bool) [create]
This flag modifies the '-f/-filename' and '-ns/-namespace' flags. Used with the '-f/-filename' flag indicates that the
file name returned will be the short name (i.e. just a file name without any directory paths). If this flag is not
present, the full name and directory path will be returned. Used with the '-ns/-namespace' flag indicates that the
namespace returned will be the base name of the namespace. (i.e. the base name of the full namespace path :AAA:BBB:CCCis
CCC
- showDagPath : sdp (bool) [create]
Shows/hides the full dag path for edits. If false only displays the node-name of reference edits. Must be used with the
-editNodes, -editStrings or -editAttrs flag.
- showNamespace : sns (bool) [create]
Shows/hides the namespaces on nodes in the reference edits. Must be used with the -editNodes, -editStrings or -editAttrs
flag
- successfulEdits : scs (bool) [create]
This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,
etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. By default
successful edits will be acted on.
- topReference : tr (bool) [create]
This flag modifies the '-rfn/-referenceNode' flag to indicate the top level ancestral reference of the target reference
will be returned.
- unresolvedName : un (bool) [create]
This flag modifies the '-f/-filename' flag to indicate that the file name returned will be unresolved (i.e. it will be
the path originally specified when the file was loaded into Maya; this path may contain environment variables and may
not exist on disk). If this flag is not present, the resolved name will be returned.
- withoutCopyNumber : wcn (bool) [create]
This flag modifies the '-f/-filename' flag to indicate that the file name returned will not have a copy number (e.g.
'{1}') appended to the end. If this flag is not present, the file name returned may have a copy number appended to the
end.
Derived from mel command `maya.cmds.referenceQuery`<|endoftext|>
|
b0f14ab4a31e5f157c48ef02fd6e32850f51f639be6f291b389fd5d0fe87218e
|
def referenceEdit(*args, **kwargs):
"\n Use this command to remove and change the modifications which have been applied to references. A valid commandTarget is\n either a reference node, a reference file, a node in a reference, or a plug from a reference. Only modifications that\n have been made from the currently open scene can be changed or removed. The 'referenceQuery -topReference' command can\n be used to determine what modifications have been made to a given commandTarget. Additionally only unapplied edits will\n be affected. Edits are unapplied when the node(s) which they affect are unloaded, or when they could not be successfully\n applied. By default this command only works on failed edits (this can be adjusted using the -failedEditsand\n -successfulEditsflags). Specifying a reference node as the command target is equivalent to specifying every node in the\n target reference file as a target. In this situation the results may differ depending on whether the target reference is\n loaded or unloaded. When it is unloaded, edits that affect both a node in the target reference and a node in one of its\n descendant references may be missed (e.g. those edits may not be removed). This is because when a reference is unloaded\n Maya no longer retains detailed information about which nodes belong to it. However, edits that only affect nodes in the\n target reference or in one of its ancestral references should be removed as expected. When the flags -removeEdits and\n -editCommand are used together, by default all connectAttr edits are removed from the specified source object. To remove\n only edits that connect to a specific target object, the target object can be passed as an additional argument to the\n command. This narrows the match criteria, so that only edits that connect the source object to the provided target in\n this additional argument are removed. See the example below. NOTE: When specifying a plug it is important to use the\n appropriate long attribute name.\n \n Flags:\n - applyFailedEdits : afe (bool) [create]\n Attempts to apply any unapplied edits. This flag is useful if previously failing edits have been fixed using the\n -changeEditTarget flag. This flag can only be used on loaded references. If the command target is a referenced node, the\n associated reference is used instead.\n \n - changeEditTarget : cet (unicode, unicode) [create]\n Used to change a target of the specified edits. This flag takes two parameters: the old target of the edits, and the new\n target to change it to. The target can either be a node name (node), a node and attribute name (node.attr), or just an\n attribute name (.attr). If an edit currently affects the old target, it will be changed to affect the new target. Flag\n 'referenceQuery' should be used to determine the format of the edit targets. As an example most edits store the long\n name of the attribute (e.g. translateX), so when specifying the old target, a long name must also be used. If the short\n name is specified (e.g. tx), chances are the edit won't be retargeted.\n \n - editCommand : ec (unicode) [create,query]\n This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this\n flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,\n connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified\n more than once to specify multiple edit types to consider.\n \n - failedEdits : fld (bool) [create]\n This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,\n etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An\n edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced\n file). By default failed edits will be acted on.\n \n - onReferenceNode : orn (unicode) [create,query]\n This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should\n be considered. This flag only supports multiple uses when specified with the exportEditscommand.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n - removeEdits : r (bool) [create]\n Remove edits which affect the specified unloaded commandTarget.\n \n - successfulEdits : scs (bool) [create]\n This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,\n etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. This flag\n will have no affect if the commandTarget is loaded. By default successful edits will not be acted on.\n \n \n Derived from mel command `maya.cmds.referenceEdit`\n "
pass
|
Use this command to remove and change the modifications which have been applied to references. A valid commandTarget is
either a reference node, a reference file, a node in a reference, or a plug from a reference. Only modifications that
have been made from the currently open scene can be changed or removed. The 'referenceQuery -topReference' command can
be used to determine what modifications have been made to a given commandTarget. Additionally only unapplied edits will
be affected. Edits are unapplied when the node(s) which they affect are unloaded, or when they could not be successfully
applied. By default this command only works on failed edits (this can be adjusted using the -failedEditsand
-successfulEditsflags). Specifying a reference node as the command target is equivalent to specifying every node in the
target reference file as a target. In this situation the results may differ depending on whether the target reference is
loaded or unloaded. When it is unloaded, edits that affect both a node in the target reference and a node in one of its
descendant references may be missed (e.g. those edits may not be removed). This is because when a reference is unloaded
Maya no longer retains detailed information about which nodes belong to it. However, edits that only affect nodes in the
target reference or in one of its ancestral references should be removed as expected. When the flags -removeEdits and
-editCommand are used together, by default all connectAttr edits are removed from the specified source object. To remove
only edits that connect to a specific target object, the target object can be passed as an additional argument to the
command. This narrows the match criteria, so that only edits that connect the source object to the provided target in
this additional argument are removed. See the example below. NOTE: When specifying a plug it is important to use the
appropriate long attribute name.
Flags:
- applyFailedEdits : afe (bool) [create]
Attempts to apply any unapplied edits. This flag is useful if previously failing edits have been fixed using the
-changeEditTarget flag. This flag can only be used on loaded references. If the command target is a referenced node, the
associated reference is used instead.
- changeEditTarget : cet (unicode, unicode) [create]
Used to change a target of the specified edits. This flag takes two parameters: the old target of the edits, and the new
target to change it to. The target can either be a node name (node), a node and attribute name (node.attr), or just an
attribute name (.attr). If an edit currently affects the old target, it will be changed to affect the new target. Flag
'referenceQuery' should be used to determine the format of the edit targets. As an example most edits store the long
name of the attribute (e.g. translateX), so when specifying the old target, a long name must also be used. If the short
name is specified (e.g. tx), chances are the edit won't be retargeted.
- editCommand : ec (unicode) [create,query]
This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this
flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,
connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified
more than once to specify multiple edit types to consider.
- failedEdits : fld (bool) [create]
This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,
etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An
edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced
file). By default failed edits will be acted on.
- onReferenceNode : orn (unicode) [create,query]
This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should
be considered. This flag only supports multiple uses when specified with the exportEditscommand.
Flag can have multiple arguments, passed either as a tuple or a list.
- removeEdits : r (bool) [create]
Remove edits which affect the specified unloaded commandTarget.
- successfulEdits : scs (bool) [create]
This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,
etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. This flag
will have no affect if the commandTarget is loaded. By default successful edits will not be acted on.
Derived from mel command `maya.cmds.referenceEdit`
|
mayaSDK/pymel/core/system.py
|
referenceEdit
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def referenceEdit(*args, **kwargs):
"\n Use this command to remove and change the modifications which have been applied to references. A valid commandTarget is\n either a reference node, a reference file, a node in a reference, or a plug from a reference. Only modifications that\n have been made from the currently open scene can be changed or removed. The 'referenceQuery -topReference' command can\n be used to determine what modifications have been made to a given commandTarget. Additionally only unapplied edits will\n be affected. Edits are unapplied when the node(s) which they affect are unloaded, or when they could not be successfully\n applied. By default this command only works on failed edits (this can be adjusted using the -failedEditsand\n -successfulEditsflags). Specifying a reference node as the command target is equivalent to specifying every node in the\n target reference file as a target. In this situation the results may differ depending on whether the target reference is\n loaded or unloaded. When it is unloaded, edits that affect both a node in the target reference and a node in one of its\n descendant references may be missed (e.g. those edits may not be removed). This is because when a reference is unloaded\n Maya no longer retains detailed information about which nodes belong to it. However, edits that only affect nodes in the\n target reference or in one of its ancestral references should be removed as expected. When the flags -removeEdits and\n -editCommand are used together, by default all connectAttr edits are removed from the specified source object. To remove\n only edits that connect to a specific target object, the target object can be passed as an additional argument to the\n command. This narrows the match criteria, so that only edits that connect the source object to the provided target in\n this additional argument are removed. See the example below. NOTE: When specifying a plug it is important to use the\n appropriate long attribute name.\n \n Flags:\n - applyFailedEdits : afe (bool) [create]\n Attempts to apply any unapplied edits. This flag is useful if previously failing edits have been fixed using the\n -changeEditTarget flag. This flag can only be used on loaded references. If the command target is a referenced node, the\n associated reference is used instead.\n \n - changeEditTarget : cet (unicode, unicode) [create]\n Used to change a target of the specified edits. This flag takes two parameters: the old target of the edits, and the new\n target to change it to. The target can either be a node name (node), a node and attribute name (node.attr), or just an\n attribute name (.attr). If an edit currently affects the old target, it will be changed to affect the new target. Flag\n 'referenceQuery' should be used to determine the format of the edit targets. As an example most edits store the long\n name of the attribute (e.g. translateX), so when specifying the old target, a long name must also be used. If the short\n name is specified (e.g. tx), chances are the edit won't be retargeted.\n \n - editCommand : ec (unicode) [create,query]\n This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this\n flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,\n connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified\n more than once to specify multiple edit types to consider.\n \n - failedEdits : fld (bool) [create]\n This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,\n etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An\n edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced\n file). By default failed edits will be acted on.\n \n - onReferenceNode : orn (unicode) [create,query]\n This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should\n be considered. This flag only supports multiple uses when specified with the exportEditscommand.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n - removeEdits : r (bool) [create]\n Remove edits which affect the specified unloaded commandTarget.\n \n - successfulEdits : scs (bool) [create]\n This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,\n etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. This flag\n will have no affect if the commandTarget is loaded. By default successful edits will not be acted on.\n \n \n Derived from mel command `maya.cmds.referenceEdit`\n "
pass
|
def referenceEdit(*args, **kwargs):
"\n Use this command to remove and change the modifications which have been applied to references. A valid commandTarget is\n either a reference node, a reference file, a node in a reference, or a plug from a reference. Only modifications that\n have been made from the currently open scene can be changed or removed. The 'referenceQuery -topReference' command can\n be used to determine what modifications have been made to a given commandTarget. Additionally only unapplied edits will\n be affected. Edits are unapplied when the node(s) which they affect are unloaded, or when they could not be successfully\n applied. By default this command only works on failed edits (this can be adjusted using the -failedEditsand\n -successfulEditsflags). Specifying a reference node as the command target is equivalent to specifying every node in the\n target reference file as a target. In this situation the results may differ depending on whether the target reference is\n loaded or unloaded. When it is unloaded, edits that affect both a node in the target reference and a node in one of its\n descendant references may be missed (e.g. those edits may not be removed). This is because when a reference is unloaded\n Maya no longer retains detailed information about which nodes belong to it. However, edits that only affect nodes in the\n target reference or in one of its ancestral references should be removed as expected. When the flags -removeEdits and\n -editCommand are used together, by default all connectAttr edits are removed from the specified source object. To remove\n only edits that connect to a specific target object, the target object can be passed as an additional argument to the\n command. This narrows the match criteria, so that only edits that connect the source object to the provided target in\n this additional argument are removed. See the example below. NOTE: When specifying a plug it is important to use the\n appropriate long attribute name.\n \n Flags:\n - applyFailedEdits : afe (bool) [create]\n Attempts to apply any unapplied edits. This flag is useful if previously failing edits have been fixed using the\n -changeEditTarget flag. This flag can only be used on loaded references. If the command target is a referenced node, the\n associated reference is used instead.\n \n - changeEditTarget : cet (unicode, unicode) [create]\n Used to change a target of the specified edits. This flag takes two parameters: the old target of the edits, and the new\n target to change it to. The target can either be a node name (node), a node and attribute name (node.attr), or just an\n attribute name (.attr). If an edit currently affects the old target, it will be changed to affect the new target. Flag\n 'referenceQuery' should be used to determine the format of the edit targets. As an example most edits store the long\n name of the attribute (e.g. translateX), so when specifying the old target, a long name must also be used. If the short\n name is specified (e.g. tx), chances are the edit won't be retargeted.\n \n - editCommand : ec (unicode) [create,query]\n This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this\n flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,\n connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified\n more than once to specify multiple edit types to consider.\n \n - failedEdits : fld (bool) [create]\n This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,\n etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An\n edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced\n file). By default failed edits will be acted on.\n \n - onReferenceNode : orn (unicode) [create,query]\n This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should\n be considered. This flag only supports multiple uses when specified with the exportEditscommand.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n - removeEdits : r (bool) [create]\n Remove edits which affect the specified unloaded commandTarget.\n \n - successfulEdits : scs (bool) [create]\n This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,\n etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. This flag\n will have no affect if the commandTarget is loaded. By default successful edits will not be acted on.\n \n \n Derived from mel command `maya.cmds.referenceEdit`\n "
pass<|docstring|>Use this command to remove and change the modifications which have been applied to references. A valid commandTarget is
either a reference node, a reference file, a node in a reference, or a plug from a reference. Only modifications that
have been made from the currently open scene can be changed or removed. The 'referenceQuery -topReference' command can
be used to determine what modifications have been made to a given commandTarget. Additionally only unapplied edits will
be affected. Edits are unapplied when the node(s) which they affect are unloaded, or when they could not be successfully
applied. By default this command only works on failed edits (this can be adjusted using the -failedEditsand
-successfulEditsflags). Specifying a reference node as the command target is equivalent to specifying every node in the
target reference file as a target. In this situation the results may differ depending on whether the target reference is
loaded or unloaded. When it is unloaded, edits that affect both a node in the target reference and a node in one of its
descendant references may be missed (e.g. those edits may not be removed). This is because when a reference is unloaded
Maya no longer retains detailed information about which nodes belong to it. However, edits that only affect nodes in the
target reference or in one of its ancestral references should be removed as expected. When the flags -removeEdits and
-editCommand are used together, by default all connectAttr edits are removed from the specified source object. To remove
only edits that connect to a specific target object, the target object can be passed as an additional argument to the
command. This narrows the match criteria, so that only edits that connect the source object to the provided target in
this additional argument are removed. See the example below. NOTE: When specifying a plug it is important to use the
appropriate long attribute name.
Flags:
- applyFailedEdits : afe (bool) [create]
Attempts to apply any unapplied edits. This flag is useful if previously failing edits have been fixed using the
-changeEditTarget flag. This flag can only be used on loaded references. If the command target is a referenced node, the
associated reference is used instead.
- changeEditTarget : cet (unicode, unicode) [create]
Used to change a target of the specified edits. This flag takes two parameters: the old target of the edits, and the new
target to change it to. The target can either be a node name (node), a node and attribute name (node.attr), or just an
attribute name (.attr). If an edit currently affects the old target, it will be changed to affect the new target. Flag
'referenceQuery' should be used to determine the format of the edit targets. As an example most edits store the long
name of the attribute (e.g. translateX), so when specifying the old target, a long name must also be used. If the short
name is specified (e.g. tx), chances are the edit won't be retargeted.
- editCommand : ec (unicode) [create,query]
This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this
flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: addAttr,
connectAttr, deleteAttr, disconnectAttr, parent, setAttr, lockand unlock. In some contexts, this flag may be specified
more than once to specify multiple edit types to consider.
- failedEdits : fld (bool) [create]
This is a secondary flag used to indicate whether or not failed edits should be acted on (e.g. queried, removed,
etc...). A failed edit is an edit which could not be successfully applied the last time its reference was loaded. An
edit can fail for a variety of reasons (e.g. the referenced node to which it applies was removed from the referenced
file). By default failed edits will be acted on.
- onReferenceNode : orn (unicode) [create,query]
This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should
be considered. This flag only supports multiple uses when specified with the exportEditscommand.
Flag can have multiple arguments, passed either as a tuple or a list.
- removeEdits : r (bool) [create]
Remove edits which affect the specified unloaded commandTarget.
- successfulEdits : scs (bool) [create]
This is a secondary flag used to indicate whether or not successful edits should be acted on (e.g. queried, removed,
etc...). A successful edit is any edit which was successfully applied the last time its reference was loaded. This flag
will have no affect if the commandTarget is loaded. By default successful edits will not be acted on.
Derived from mel command `maya.cmds.referenceEdit`<|endoftext|>
|
f3bf2e99b082e9649557aabd27fe24da6457452cd26ae0993c20d9c097d8a50b
|
def audioTrack(*args, **kwargs):
"\n This command is used for inserting and removing tracks related to the audio clips displayed in the sequencer. It can\n also be used to modify the track state, for example, to lock or mute a track. In query mode, return type\n is based on queried flag.\n \n Flags:\n - insertTrack : it (int) [create]\n This flag is used to insert a new empty track at the track index specified. Indices are 1-based.\n \n - lock : l (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be locked at their\n current location and track.\n \n - mute : m (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be muted or not.\n \n - numTracks : nt (int) [query]\n To query the number of audio tracks\n \n - removeEmptyTracks : ret (bool) [create]\n This flag is used to remove all tracks that have no clips.\n \n - removeTrack : rt (int) [create]\n This flag is used to remove the track with the specified index. The track must have no clips on it before it can be\n removed.\n \n - solo : so (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be soloed or not.\n \n - swapTracks : st (int, int) [create]\n This flag is used to swap the contents of two specified tracks. Indices are 1-based.\n \n - title : t (unicode) [create,query,edit]\n This flag specifies the title for the track.\n \n - track : tr (int) [create,query,edit]\n Specify the track on which to operate by using the track's trackNumber. Flag can have multiple arguments, passed either\n as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.audioTrack`\n "
pass
|
This command is used for inserting and removing tracks related to the audio clips displayed in the sequencer. It can
also be used to modify the track state, for example, to lock or mute a track. In query mode, return type
is based on queried flag.
Flags:
- insertTrack : it (int) [create]
This flag is used to insert a new empty track at the track index specified. Indices are 1-based.
- lock : l (bool) [create,query,edit]
This flag specifies whether all audio clips on the same track as the specified audio node are to be locked at their
current location and track.
- mute : m (bool) [create,query,edit]
This flag specifies whether all audio clips on the same track as the specified audio node are to be muted or not.
- numTracks : nt (int) [query]
To query the number of audio tracks
- removeEmptyTracks : ret (bool) [create]
This flag is used to remove all tracks that have no clips.
- removeTrack : rt (int) [create]
This flag is used to remove the track with the specified index. The track must have no clips on it before it can be
removed.
- solo : so (bool) [create,query,edit]
This flag specifies whether all audio clips on the same track as the specified audio node are to be soloed or not.
- swapTracks : st (int, int) [create]
This flag is used to swap the contents of two specified tracks. Indices are 1-based.
- title : t (unicode) [create,query,edit]
This flag specifies the title for the track.
- track : tr (int) [create,query,edit]
Specify the track on which to operate by using the track's trackNumber. Flag can have multiple arguments, passed either
as a tuple or a list.
Derived from mel command `maya.cmds.audioTrack`
|
mayaSDK/pymel/core/system.py
|
audioTrack
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def audioTrack(*args, **kwargs):
"\n This command is used for inserting and removing tracks related to the audio clips displayed in the sequencer. It can\n also be used to modify the track state, for example, to lock or mute a track. In query mode, return type\n is based on queried flag.\n \n Flags:\n - insertTrack : it (int) [create]\n This flag is used to insert a new empty track at the track index specified. Indices are 1-based.\n \n - lock : l (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be locked at their\n current location and track.\n \n - mute : m (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be muted or not.\n \n - numTracks : nt (int) [query]\n To query the number of audio tracks\n \n - removeEmptyTracks : ret (bool) [create]\n This flag is used to remove all tracks that have no clips.\n \n - removeTrack : rt (int) [create]\n This flag is used to remove the track with the specified index. The track must have no clips on it before it can be\n removed.\n \n - solo : so (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be soloed or not.\n \n - swapTracks : st (int, int) [create]\n This flag is used to swap the contents of two specified tracks. Indices are 1-based.\n \n - title : t (unicode) [create,query,edit]\n This flag specifies the title for the track.\n \n - track : tr (int) [create,query,edit]\n Specify the track on which to operate by using the track's trackNumber. Flag can have multiple arguments, passed either\n as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.audioTrack`\n "
pass
|
def audioTrack(*args, **kwargs):
"\n This command is used for inserting and removing tracks related to the audio clips displayed in the sequencer. It can\n also be used to modify the track state, for example, to lock or mute a track. In query mode, return type\n is based on queried flag.\n \n Flags:\n - insertTrack : it (int) [create]\n This flag is used to insert a new empty track at the track index specified. Indices are 1-based.\n \n - lock : l (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be locked at their\n current location and track.\n \n - mute : m (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be muted or not.\n \n - numTracks : nt (int) [query]\n To query the number of audio tracks\n \n - removeEmptyTracks : ret (bool) [create]\n This flag is used to remove all tracks that have no clips.\n \n - removeTrack : rt (int) [create]\n This flag is used to remove the track with the specified index. The track must have no clips on it before it can be\n removed.\n \n - solo : so (bool) [create,query,edit]\n This flag specifies whether all audio clips on the same track as the specified audio node are to be soloed or not.\n \n - swapTracks : st (int, int) [create]\n This flag is used to swap the contents of two specified tracks. Indices are 1-based.\n \n - title : t (unicode) [create,query,edit]\n This flag specifies the title for the track.\n \n - track : tr (int) [create,query,edit]\n Specify the track on which to operate by using the track's trackNumber. Flag can have multiple arguments, passed either\n as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.audioTrack`\n "
pass<|docstring|>This command is used for inserting and removing tracks related to the audio clips displayed in the sequencer. It can
also be used to modify the track state, for example, to lock or mute a track. In query mode, return type
is based on queried flag.
Flags:
- insertTrack : it (int) [create]
This flag is used to insert a new empty track at the track index specified. Indices are 1-based.
- lock : l (bool) [create,query,edit]
This flag specifies whether all audio clips on the same track as the specified audio node are to be locked at their
current location and track.
- mute : m (bool) [create,query,edit]
This flag specifies whether all audio clips on the same track as the specified audio node are to be muted or not.
- numTracks : nt (int) [query]
To query the number of audio tracks
- removeEmptyTracks : ret (bool) [create]
This flag is used to remove all tracks that have no clips.
- removeTrack : rt (int) [create]
This flag is used to remove the track with the specified index. The track must have no clips on it before it can be
removed.
- solo : so (bool) [create,query,edit]
This flag specifies whether all audio clips on the same track as the specified audio node are to be soloed or not.
- swapTracks : st (int, int) [create]
This flag is used to swap the contents of two specified tracks. Indices are 1-based.
- title : t (unicode) [create,query,edit]
This flag specifies the title for the track.
- track : tr (int) [create,query,edit]
Specify the track on which to operate by using the track's trackNumber. Flag can have multiple arguments, passed either
as a tuple or a list.
Derived from mel command `maya.cmds.audioTrack`<|endoftext|>
|
5ee7b9693bb02e3a5f9f3844a2fae7df08a45153250b5d55b843731d8240ebdf
|
def translator(*args, **kwargs):
'\n Set or query parameters associated with the file translators specified in as the argument.\n \n Flags:\n - defaultFileRule : dfr (bool) [query]\n Returns the default file rule value, can return as well\n \n - defaultOptions : do (unicode) [query]\n Return/set a string of default options used by this translator.\n \n - extension : ext (bool) [query]\n Returns the default file extension for this translator.\n \n - fileCompression : cmp (unicode) [query]\n Specifies the compression action to take when a file is saved. Possible values are compressed, uncompressedasCompressed.\n \n - filter : f (bool) [query]\n Returns the filter string used for this translator.\n \n - list : l (bool) [query]\n Return a string array of all the translators that are loaded.\n \n - loaded : ld (bool) [query]\n Returns true if the given translator is currently loaded.\n \n - objectType : ot (bool) [query]\n This flag is obsolete. This will now return the same results as defaultFileRule going forward.\n \n - optionsScript : os (bool) [query]\n Query the name of the options script to use to post the user options UI. When this script is invoked it will expect the\n name of the parent layout in which the options will be displayed as well as the name of the callback to be invoked once\n the apply button has been depressed in the options area.\n \n - readSupport : rs (bool) [query]\n Returns true if this translator supports read operations.\n \n - writeSupport : ws (bool) [query]\n Returns true if this translator supports write operations. Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.translator`\n '
pass
|
Set or query parameters associated with the file translators specified in as the argument.
Flags:
- defaultFileRule : dfr (bool) [query]
Returns the default file rule value, can return as well
- defaultOptions : do (unicode) [query]
Return/set a string of default options used by this translator.
- extension : ext (bool) [query]
Returns the default file extension for this translator.
- fileCompression : cmp (unicode) [query]
Specifies the compression action to take when a file is saved. Possible values are compressed, uncompressedasCompressed.
- filter : f (bool) [query]
Returns the filter string used for this translator.
- list : l (bool) [query]
Return a string array of all the translators that are loaded.
- loaded : ld (bool) [query]
Returns true if the given translator is currently loaded.
- objectType : ot (bool) [query]
This flag is obsolete. This will now return the same results as defaultFileRule going forward.
- optionsScript : os (bool) [query]
Query the name of the options script to use to post the user options UI. When this script is invoked it will expect the
name of the parent layout in which the options will be displayed as well as the name of the callback to be invoked once
the apply button has been depressed in the options area.
- readSupport : rs (bool) [query]
Returns true if this translator supports read operations.
- writeSupport : ws (bool) [query]
Returns true if this translator supports write operations. Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.translator`
|
mayaSDK/pymel/core/system.py
|
translator
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def translator(*args, **kwargs):
'\n Set or query parameters associated with the file translators specified in as the argument.\n \n Flags:\n - defaultFileRule : dfr (bool) [query]\n Returns the default file rule value, can return as well\n \n - defaultOptions : do (unicode) [query]\n Return/set a string of default options used by this translator.\n \n - extension : ext (bool) [query]\n Returns the default file extension for this translator.\n \n - fileCompression : cmp (unicode) [query]\n Specifies the compression action to take when a file is saved. Possible values are compressed, uncompressedasCompressed.\n \n - filter : f (bool) [query]\n Returns the filter string used for this translator.\n \n - list : l (bool) [query]\n Return a string array of all the translators that are loaded.\n \n - loaded : ld (bool) [query]\n Returns true if the given translator is currently loaded.\n \n - objectType : ot (bool) [query]\n This flag is obsolete. This will now return the same results as defaultFileRule going forward.\n \n - optionsScript : os (bool) [query]\n Query the name of the options script to use to post the user options UI. When this script is invoked it will expect the\n name of the parent layout in which the options will be displayed as well as the name of the callback to be invoked once\n the apply button has been depressed in the options area.\n \n - readSupport : rs (bool) [query]\n Returns true if this translator supports read operations.\n \n - writeSupport : ws (bool) [query]\n Returns true if this translator supports write operations. Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.translator`\n '
pass
|
def translator(*args, **kwargs):
'\n Set or query parameters associated with the file translators specified in as the argument.\n \n Flags:\n - defaultFileRule : dfr (bool) [query]\n Returns the default file rule value, can return as well\n \n - defaultOptions : do (unicode) [query]\n Return/set a string of default options used by this translator.\n \n - extension : ext (bool) [query]\n Returns the default file extension for this translator.\n \n - fileCompression : cmp (unicode) [query]\n Specifies the compression action to take when a file is saved. Possible values are compressed, uncompressedasCompressed.\n \n - filter : f (bool) [query]\n Returns the filter string used for this translator.\n \n - list : l (bool) [query]\n Return a string array of all the translators that are loaded.\n \n - loaded : ld (bool) [query]\n Returns true if the given translator is currently loaded.\n \n - objectType : ot (bool) [query]\n This flag is obsolete. This will now return the same results as defaultFileRule going forward.\n \n - optionsScript : os (bool) [query]\n Query the name of the options script to use to post the user options UI. When this script is invoked it will expect the\n name of the parent layout in which the options will be displayed as well as the name of the callback to be invoked once\n the apply button has been depressed in the options area.\n \n - readSupport : rs (bool) [query]\n Returns true if this translator supports read operations.\n \n - writeSupport : ws (bool) [query]\n Returns true if this translator supports write operations. Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.translator`\n '
pass<|docstring|>Set or query parameters associated with the file translators specified in as the argument.
Flags:
- defaultFileRule : dfr (bool) [query]
Returns the default file rule value, can return as well
- defaultOptions : do (unicode) [query]
Return/set a string of default options used by this translator.
- extension : ext (bool) [query]
Returns the default file extension for this translator.
- fileCompression : cmp (unicode) [query]
Specifies the compression action to take when a file is saved. Possible values are compressed, uncompressedasCompressed.
- filter : f (bool) [query]
Returns the filter string used for this translator.
- list : l (bool) [query]
Return a string array of all the translators that are loaded.
- loaded : ld (bool) [query]
Returns true if the given translator is currently loaded.
- objectType : ot (bool) [query]
This flag is obsolete. This will now return the same results as defaultFileRule going forward.
- optionsScript : os (bool) [query]
Query the name of the options script to use to post the user options UI. When this script is invoked it will expect the
name of the parent layout in which the options will be displayed as well as the name of the callback to be invoked once
the apply button has been depressed in the options area.
- readSupport : rs (bool) [query]
Returns true if this translator supports read operations.
- writeSupport : ws (bool) [query]
Returns true if this translator supports write operations. Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.translator`<|endoftext|>
|
a152e37a37a223558406525dd6f56db523b3b95cdc04971f4927690c7cf863b9
|
def listInputDeviceAxes(*args, **kwargs):
'\n This command lists all of the axes of the specified input device.\n \n Dynamic library stub function\n \n \n Derived from mel command `maya.cmds.listInputDeviceAxes`\n '
pass
|
This command lists all of the axes of the specified input device.
Dynamic library stub function
Derived from mel command `maya.cmds.listInputDeviceAxes`
|
mayaSDK/pymel/core/system.py
|
listInputDeviceAxes
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def listInputDeviceAxes(*args, **kwargs):
'\n This command lists all of the axes of the specified input device.\n \n Dynamic library stub function\n \n \n Derived from mel command `maya.cmds.listInputDeviceAxes`\n '
pass
|
def listInputDeviceAxes(*args, **kwargs):
'\n This command lists all of the axes of the specified input device.\n \n Dynamic library stub function\n \n \n Derived from mel command `maya.cmds.listInputDeviceAxes`\n '
pass<|docstring|>This command lists all of the axes of the specified input device.
Dynamic library stub function
Derived from mel command `maya.cmds.listInputDeviceAxes`<|endoftext|>
|
d4b27c19c162f710674b8577945f8d366d71a08d8015e1e67b0724d668d42afe
|
def timer(*args, **kwargs):
"\n Allow simple timing of scripts and commands. The resolution of this timer is at the level of your OS's\n gettimeofday()function. Note:This command does not handle stacked calls. For example, this code below will give an\n incorrect answer on the second timer -ecall.timer -s; timer -s; timer -e; timer -e; To do this use named timers: timer\n -s; timer -s -name innerTimer; timer -e -name innerTimer; timer -e; I the -e flag or -lap flag return the time elapsed\n since the last 'timer -s' call.I the -s flag has no return value.\n \n Flags:\n - endTimer : e (bool) [create]\n Stop the timer and return the time elapsed since the timer was started (in seconds). Once a timer is turned off it no\n longer exists, though it can be recreated with a new start\n \n - lapTime : lap (bool) [create]\n Get the lap time of the timer (time elapsed since start in seconds). Unlike the endflag this keeps the timer running.\n \n - name : n (unicode) [create]\n Use a named timer for the operation. If this is omitted then the default timer is assumed.\n \n - startTimer : s (bool) [create]\n Start the timer. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.timer`\n "
pass
|
Allow simple timing of scripts and commands. The resolution of this timer is at the level of your OS's
gettimeofday()function. Note:This command does not handle stacked calls. For example, this code below will give an
incorrect answer on the second timer -ecall.timer -s; timer -s; timer -e; timer -e; To do this use named timers: timer
-s; timer -s -name innerTimer; timer -e -name innerTimer; timer -e; I the -e flag or -lap flag return the time elapsed
since the last 'timer -s' call.I the -s flag has no return value.
Flags:
- endTimer : e (bool) [create]
Stop the timer and return the time elapsed since the timer was started (in seconds). Once a timer is turned off it no
longer exists, though it can be recreated with a new start
- lapTime : lap (bool) [create]
Get the lap time of the timer (time elapsed since start in seconds). Unlike the endflag this keeps the timer running.
- name : n (unicode) [create]
Use a named timer for the operation. If this is omitted then the default timer is assumed.
- startTimer : s (bool) [create]
Start the timer. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.timer`
|
mayaSDK/pymel/core/system.py
|
timer
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def timer(*args, **kwargs):
"\n Allow simple timing of scripts and commands. The resolution of this timer is at the level of your OS's\n gettimeofday()function. Note:This command does not handle stacked calls. For example, this code below will give an\n incorrect answer on the second timer -ecall.timer -s; timer -s; timer -e; timer -e; To do this use named timers: timer\n -s; timer -s -name innerTimer; timer -e -name innerTimer; timer -e; I the -e flag or -lap flag return the time elapsed\n since the last 'timer -s' call.I the -s flag has no return value.\n \n Flags:\n - endTimer : e (bool) [create]\n Stop the timer and return the time elapsed since the timer was started (in seconds). Once a timer is turned off it no\n longer exists, though it can be recreated with a new start\n \n - lapTime : lap (bool) [create]\n Get the lap time of the timer (time elapsed since start in seconds). Unlike the endflag this keeps the timer running.\n \n - name : n (unicode) [create]\n Use a named timer for the operation. If this is omitted then the default timer is assumed.\n \n - startTimer : s (bool) [create]\n Start the timer. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.timer`\n "
pass
|
def timer(*args, **kwargs):
"\n Allow simple timing of scripts and commands. The resolution of this timer is at the level of your OS's\n gettimeofday()function. Note:This command does not handle stacked calls. For example, this code below will give an\n incorrect answer on the second timer -ecall.timer -s; timer -s; timer -e; timer -e; To do this use named timers: timer\n -s; timer -s -name innerTimer; timer -e -name innerTimer; timer -e; I the -e flag or -lap flag return the time elapsed\n since the last 'timer -s' call.I the -s flag has no return value.\n \n Flags:\n - endTimer : e (bool) [create]\n Stop the timer and return the time elapsed since the timer was started (in seconds). Once a timer is turned off it no\n longer exists, though it can be recreated with a new start\n \n - lapTime : lap (bool) [create]\n Get the lap time of the timer (time elapsed since start in seconds). Unlike the endflag this keeps the timer running.\n \n - name : n (unicode) [create]\n Use a named timer for the operation. If this is omitted then the default timer is assumed.\n \n - startTimer : s (bool) [create]\n Start the timer. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.timer`\n "
pass<|docstring|>Allow simple timing of scripts and commands. The resolution of this timer is at the level of your OS's
gettimeofday()function. Note:This command does not handle stacked calls. For example, this code below will give an
incorrect answer on the second timer -ecall.timer -s; timer -s; timer -e; timer -e; To do this use named timers: timer
-s; timer -s -name innerTimer; timer -e -name innerTimer; timer -e; I the -e flag or -lap flag return the time elapsed
since the last 'timer -s' call.I the -s flag has no return value.
Flags:
- endTimer : e (bool) [create]
Stop the timer and return the time elapsed since the timer was started (in seconds). Once a timer is turned off it no
longer exists, though it can be recreated with a new start
- lapTime : lap (bool) [create]
Get the lap time of the timer (time elapsed since start in seconds). Unlike the endflag this keeps the timer running.
- name : n (unicode) [create]
Use a named timer for the operation. If this is omitted then the default timer is assumed.
- startTimer : s (bool) [create]
Start the timer. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.timer`<|endoftext|>
|
60476b983bcb03235c3cd5bfed832c72e2cc5bb8cffca650727fdee43d724956
|
def warning(*args, **kwargs):
'\n The warning command is provided so that the user can issue warning messages from his/her scripts. The string argument is\n displayed in the command window (or stdout if running in batch mode) after being prefixed with a warning message heading\n and surrounded by the appropriate language separators (# for Python, // for Mel).\n \n Flags:\n - noContext : n (bool) [create]\n Do not include the context information with the warning message.\n \n - showLineNumber : sl (bool) [create]\n Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number\n display instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.warning`\n '
pass
|
The warning command is provided so that the user can issue warning messages from his/her scripts. The string argument is
displayed in the command window (or stdout if running in batch mode) after being prefixed with a warning message heading
and surrounded by the appropriate language separators (# for Python, // for Mel).
Flags:
- noContext : n (bool) [create]
Do not include the context information with the warning message.
- showLineNumber : sl (bool) [create]
Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number
display instead. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.warning`
|
mayaSDK/pymel/core/system.py
|
warning
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def warning(*args, **kwargs):
'\n The warning command is provided so that the user can issue warning messages from his/her scripts. The string argument is\n displayed in the command window (or stdout if running in batch mode) after being prefixed with a warning message heading\n and surrounded by the appropriate language separators (# for Python, // for Mel).\n \n Flags:\n - noContext : n (bool) [create]\n Do not include the context information with the warning message.\n \n - showLineNumber : sl (bool) [create]\n Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number\n display instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.warning`\n '
pass
|
def warning(*args, **kwargs):
'\n The warning command is provided so that the user can issue warning messages from his/her scripts. The string argument is\n displayed in the command window (or stdout if running in batch mode) after being prefixed with a warning message heading\n and surrounded by the appropriate language separators (# for Python, // for Mel).\n \n Flags:\n - noContext : n (bool) [create]\n Do not include the context information with the warning message.\n \n - showLineNumber : sl (bool) [create]\n Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number\n display instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.warning`\n '
pass<|docstring|>The warning command is provided so that the user can issue warning messages from his/her scripts. The string argument is
displayed in the command window (or stdout if running in batch mode) after being prefixed with a warning message heading
and surrounded by the appropriate language separators (# for Python, // for Mel).
Flags:
- noContext : n (bool) [create]
Do not include the context information with the warning message.
- showLineNumber : sl (bool) [create]
Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number
display instead. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.warning`<|endoftext|>
|
540cb27a125c1bbb28f30d0deb6ad6ce2832edf22f1fa6da2de98056acb9a92b
|
def exportAsReference(exportPath, **kwargs):
'\n Export the selected objects into a reference file with the given name. The file is saved on disk during the process. Returns the name of the reference created. \n \n Flags:\n - namespace:\n The namespace name to use that will group all objects during importing and referencing. Change the namespace used to\n group all the objects from the specified referenced file. The reference must have been created with the Using\n Namespacesoption, and must be loaded. Non-referenced nodes contained in the existing namespace will also be moved to the\n new namespace. The new namespace will be created by this command and can not already exist. The old namespace will be\n removed.\n - renamingPrefix:\n The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Export the selected objects into a reference file with the given name. The file is saved on disk during the process. Returns the name of the reference created.
Flags:
- namespace:
The namespace name to use that will group all objects during importing and referencing. Change the namespace used to
group all the objects from the specified referenced file. The reference must have been created with the Using
Namespacesoption, and must be loaded. Non-referenced nodes contained in the existing namespace will also be moved to the
new namespace. The new namespace will be created by this command and can not already exist. The old namespace will be
removed.
- renamingPrefix:
The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
exportAsReference
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def exportAsReference(exportPath, **kwargs):
'\n Export the selected objects into a reference file with the given name. The file is saved on disk during the process. Returns the name of the reference created. \n \n Flags:\n - namespace:\n The namespace name to use that will group all objects during importing and referencing. Change the namespace used to\n group all the objects from the specified referenced file. The reference must have been created with the Using\n Namespacesoption, and must be loaded. Non-referenced nodes contained in the existing namespace will also be moved to the\n new namespace. The new namespace will be created by this command and can not already exist. The old namespace will be\n removed.\n - renamingPrefix:\n The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def exportAsReference(exportPath, **kwargs):
'\n Export the selected objects into a reference file with the given name. The file is saved on disk during the process. Returns the name of the reference created. \n \n Flags:\n - namespace:\n The namespace name to use that will group all objects during importing and referencing. Change the namespace used to\n group all the objects from the specified referenced file. The reference must have been created with the Using\n Namespacesoption, and must be loaded. Non-referenced nodes contained in the existing namespace will also be moved to the\n new namespace. The new namespace will be created by this command and can not already exist. The old namespace will be\n removed.\n - renamingPrefix:\n The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.\n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Export the selected objects into a reference file with the given name. The file is saved on disk during the process. Returns the name of the reference created.
Flags:
- namespace:
The namespace name to use that will group all objects during importing and referencing. Change the namespace used to
group all the objects from the specified referenced file. The reference must have been created with the Using
Namespacesoption, and must be loaded. Non-referenced nodes contained in the existing namespace will also be moved to the
new namespace. The new namespace will be created by this command and can not already exist. The old namespace will be
removed.
- renamingPrefix:
The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
e9f5c241a3e124513688bbf43b49c8f8ea1a61831e78f46f93d64179e05aebb6
|
def profiler(*args, **kwargs):
"\n The profiler is used to record timing information from key events within Maya, as an aid in tuning the performance of\n scenes, scripts and plug-ins. User written plug-ins and Python scripts can also generate profiling information for their\n own code through the MProfilingScope and MProfiler classes in the API. This command provides the ability to control the\n collection of profiling data and to query information about the recorded events. The recorded information can also be\n viewed graphically in the Profiler window. The buffer size cannot be changed while sampling is active, it will return an\n error The reset flag cannot be called while sampling is active, it will return an error. Any changes to the buffer size\n will only be applied on start of the next recording. You can't save and load in the same command, save has priority,\n load would be ignored. In query mode, return type is based on queried flag.\n \n Flags:\n - addCategory : a (unicode) [create]\n Add a new category for the profiler. Returns the index of the new category.\n \n - allCategories : ac (bool) [query]\n Query the names of all categories\n \n - bufferSize : b (int) [create,query]\n Toggled : change the buffer size to fit the specified number of events (requires that sampling is off) Query : return\n the current buffer size The new buffer size will only take effect when next sampling starts. When the buffer is full,\n the recording stops.\n \n - categoryIndex : ci (int) [create,query]\n Used in conjunction with other flags, to indicate the index of the category.\n \n - categoryIndexToName : cin (int) [create,query]\n Returns the name of the category with a given index.\n \n - categoryName : cn (unicode) [query]\n Used in conjunction with other flags, to indicate the name of the category.\n \n - categoryNameToIndex : cni (unicode) [create,query]\n Returns the index of the category with a given name.\n \n - categoryRecording : cr (bool) [create,query]\n Toggled : Enable/disable the recording of the category. Query : return if the recording of the category is On. Requires\n the -categoryIndex or -categoryName flag to specify the category to be queried.\n \n - clearAllMelInstrumentation : cam (bool) [create]\n Clear all MEL command or procedure instrumentation.\n \n - colorIndex : coi (int) [create]\n Used with -instrumentMel trueto specify the color index to show the profiling result.\n \n - eventCPUId : eci (bool) [query]\n Query the CPU ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventCategory : eca (bool) [query]\n Query the category index the event at the given index belongs to. Requires the -eventIndex flag to specify the event to\n be queried.\n \n - eventColor : eco (bool) [query]\n Query the color of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventCount : ec (bool) [query]\n Query the number of events in the buffer\n \n - eventDescription : ed (bool) [query]\n Query the description of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventDuration : edu (bool) [query]\n Query the duration of the event at the given index, the time unit is microsecond. Note that a signal event has a 0\n duration. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventIndex : ei (int) [query]\n Used usually in conjunction with other flags, to indicate the index of the event.\n \n - eventName : en (bool) [query]\n Query the name of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventStartTime : et (bool) [query]\n Query the time of the event at the given index, the time unit is microsecond. Requires the -eventIndex flag to specify\n the event to be queried.\n \n - eventThreadId : eti (bool) [query]\n Query the thread ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - instrumentMel : instrumentMel (bool) [create]\n Enable/Diable the instrumentation of a MEL command or procedure. When the instrumentation is enabled, the execution of\n MEL command or procedure can be profiled and shown in the Profiler window. To enable the instrumentation requires the\n -procedureName, -colorIndex and -categoryIndex flags. To disable the instrumentation requires the -procedureName flag.\n \n - load : l (unicode) [create,query]\n Read the recorded events from the specified file\n \n - output : o (unicode) [create,query]\n Output the recorded events to the specified file\n \n - procedureDescription : pd (unicode) [create]\n Used with -instrumentMel trueto provide a description of the MEL command or procedure being instrumented. This\n description can be viewed in the Profiler Tool window.\n \n - procedureName : pn (unicode) [create]\n Used with -instrumentMel to specify the name of the procedure to be enabled/disabled the instrumentation.\n \n - removeCategory : rc (unicode) [create]\n Remove an existing category for the profiler. Returns the index of the removed category.\n \n - reset : r (bool) [create,query]\n reset the profiler's data (requires that sampling is off)\n \n - sampling : s (bool) [create,query]\n Toggled : Enable/disable the recording of events Query : return if the recording of events is On.\n \n - signalEvent : sig (bool) [query]\n Query if the event at the given index is a signal event. Requires the -eventIndex flag to specify the event to be\n queried. A Signal Event only remembers the start moment and has no knowledge about duration. It can be used in cases\n when the user does not care about the duration but only cares if this event does happen.\n \n - signalMelEvent : sim (bool) [create]\n Used with -instrumentMel true, inform profiler that this instrumented MEL command or procedure will be taken as a signal\n event during profiling. A Signal Event only remembers the start moment and has no knowledge about duration. It can be\n used in cases when the user does not care about the duration but only cares if this event does happen.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.profiler`\n "
pass
|
The profiler is used to record timing information from key events within Maya, as an aid in tuning the performance of
scenes, scripts and plug-ins. User written plug-ins and Python scripts can also generate profiling information for their
own code through the MProfilingScope and MProfiler classes in the API. This command provides the ability to control the
collection of profiling data and to query information about the recorded events. The recorded information can also be
viewed graphically in the Profiler window. The buffer size cannot be changed while sampling is active, it will return an
error The reset flag cannot be called while sampling is active, it will return an error. Any changes to the buffer size
will only be applied on start of the next recording. You can't save and load in the same command, save has priority,
load would be ignored. In query mode, return type is based on queried flag.
Flags:
- addCategory : a (unicode) [create]
Add a new category for the profiler. Returns the index of the new category.
- allCategories : ac (bool) [query]
Query the names of all categories
- bufferSize : b (int) [create,query]
Toggled : change the buffer size to fit the specified number of events (requires that sampling is off) Query : return
the current buffer size The new buffer size will only take effect when next sampling starts. When the buffer is full,
the recording stops.
- categoryIndex : ci (int) [create,query]
Used in conjunction with other flags, to indicate the index of the category.
- categoryIndexToName : cin (int) [create,query]
Returns the name of the category with a given index.
- categoryName : cn (unicode) [query]
Used in conjunction with other flags, to indicate the name of the category.
- categoryNameToIndex : cni (unicode) [create,query]
Returns the index of the category with a given name.
- categoryRecording : cr (bool) [create,query]
Toggled : Enable/disable the recording of the category. Query : return if the recording of the category is On. Requires
the -categoryIndex or -categoryName flag to specify the category to be queried.
- clearAllMelInstrumentation : cam (bool) [create]
Clear all MEL command or procedure instrumentation.
- colorIndex : coi (int) [create]
Used with -instrumentMel trueto specify the color index to show the profiling result.
- eventCPUId : eci (bool) [query]
Query the CPU ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventCategory : eca (bool) [query]
Query the category index the event at the given index belongs to. Requires the -eventIndex flag to specify the event to
be queried.
- eventColor : eco (bool) [query]
Query the color of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventCount : ec (bool) [query]
Query the number of events in the buffer
- eventDescription : ed (bool) [query]
Query the description of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventDuration : edu (bool) [query]
Query the duration of the event at the given index, the time unit is microsecond. Note that a signal event has a 0
duration. Requires the -eventIndex flag to specify the event to be queried.
- eventIndex : ei (int) [query]
Used usually in conjunction with other flags, to indicate the index of the event.
- eventName : en (bool) [query]
Query the name of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventStartTime : et (bool) [query]
Query the time of the event at the given index, the time unit is microsecond. Requires the -eventIndex flag to specify
the event to be queried.
- eventThreadId : eti (bool) [query]
Query the thread ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- instrumentMel : instrumentMel (bool) [create]
Enable/Diable the instrumentation of a MEL command or procedure. When the instrumentation is enabled, the execution of
MEL command or procedure can be profiled and shown in the Profiler window. To enable the instrumentation requires the
-procedureName, -colorIndex and -categoryIndex flags. To disable the instrumentation requires the -procedureName flag.
- load : l (unicode) [create,query]
Read the recorded events from the specified file
- output : o (unicode) [create,query]
Output the recorded events to the specified file
- procedureDescription : pd (unicode) [create]
Used with -instrumentMel trueto provide a description of the MEL command or procedure being instrumented. This
description can be viewed in the Profiler Tool window.
- procedureName : pn (unicode) [create]
Used with -instrumentMel to specify the name of the procedure to be enabled/disabled the instrumentation.
- removeCategory : rc (unicode) [create]
Remove an existing category for the profiler. Returns the index of the removed category.
- reset : r (bool) [create,query]
reset the profiler's data (requires that sampling is off)
- sampling : s (bool) [create,query]
Toggled : Enable/disable the recording of events Query : return if the recording of events is On.
- signalEvent : sig (bool) [query]
Query if the event at the given index is a signal event. Requires the -eventIndex flag to specify the event to be
queried. A Signal Event only remembers the start moment and has no knowledge about duration. It can be used in cases
when the user does not care about the duration but only cares if this event does happen.
- signalMelEvent : sim (bool) [create]
Used with -instrumentMel true, inform profiler that this instrumented MEL command or procedure will be taken as a signal
event during profiling. A Signal Event only remembers the start moment and has no knowledge about duration. It can be
used in cases when the user does not care about the duration but only cares if this event does happen.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.profiler`
|
mayaSDK/pymel/core/system.py
|
profiler
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def profiler(*args, **kwargs):
"\n The profiler is used to record timing information from key events within Maya, as an aid in tuning the performance of\n scenes, scripts and plug-ins. User written plug-ins and Python scripts can also generate profiling information for their\n own code through the MProfilingScope and MProfiler classes in the API. This command provides the ability to control the\n collection of profiling data and to query information about the recorded events. The recorded information can also be\n viewed graphically in the Profiler window. The buffer size cannot be changed while sampling is active, it will return an\n error The reset flag cannot be called while sampling is active, it will return an error. Any changes to the buffer size\n will only be applied on start of the next recording. You can't save and load in the same command, save has priority,\n load would be ignored. In query mode, return type is based on queried flag.\n \n Flags:\n - addCategory : a (unicode) [create]\n Add a new category for the profiler. Returns the index of the new category.\n \n - allCategories : ac (bool) [query]\n Query the names of all categories\n \n - bufferSize : b (int) [create,query]\n Toggled : change the buffer size to fit the specified number of events (requires that sampling is off) Query : return\n the current buffer size The new buffer size will only take effect when next sampling starts. When the buffer is full,\n the recording stops.\n \n - categoryIndex : ci (int) [create,query]\n Used in conjunction with other flags, to indicate the index of the category.\n \n - categoryIndexToName : cin (int) [create,query]\n Returns the name of the category with a given index.\n \n - categoryName : cn (unicode) [query]\n Used in conjunction with other flags, to indicate the name of the category.\n \n - categoryNameToIndex : cni (unicode) [create,query]\n Returns the index of the category with a given name.\n \n - categoryRecording : cr (bool) [create,query]\n Toggled : Enable/disable the recording of the category. Query : return if the recording of the category is On. Requires\n the -categoryIndex or -categoryName flag to specify the category to be queried.\n \n - clearAllMelInstrumentation : cam (bool) [create]\n Clear all MEL command or procedure instrumentation.\n \n - colorIndex : coi (int) [create]\n Used with -instrumentMel trueto specify the color index to show the profiling result.\n \n - eventCPUId : eci (bool) [query]\n Query the CPU ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventCategory : eca (bool) [query]\n Query the category index the event at the given index belongs to. Requires the -eventIndex flag to specify the event to\n be queried.\n \n - eventColor : eco (bool) [query]\n Query the color of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventCount : ec (bool) [query]\n Query the number of events in the buffer\n \n - eventDescription : ed (bool) [query]\n Query the description of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventDuration : edu (bool) [query]\n Query the duration of the event at the given index, the time unit is microsecond. Note that a signal event has a 0\n duration. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventIndex : ei (int) [query]\n Used usually in conjunction with other flags, to indicate the index of the event.\n \n - eventName : en (bool) [query]\n Query the name of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventStartTime : et (bool) [query]\n Query the time of the event at the given index, the time unit is microsecond. Requires the -eventIndex flag to specify\n the event to be queried.\n \n - eventThreadId : eti (bool) [query]\n Query the thread ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - instrumentMel : instrumentMel (bool) [create]\n Enable/Diable the instrumentation of a MEL command or procedure. When the instrumentation is enabled, the execution of\n MEL command or procedure can be profiled and shown in the Profiler window. To enable the instrumentation requires the\n -procedureName, -colorIndex and -categoryIndex flags. To disable the instrumentation requires the -procedureName flag.\n \n - load : l (unicode) [create,query]\n Read the recorded events from the specified file\n \n - output : o (unicode) [create,query]\n Output the recorded events to the specified file\n \n - procedureDescription : pd (unicode) [create]\n Used with -instrumentMel trueto provide a description of the MEL command or procedure being instrumented. This\n description can be viewed in the Profiler Tool window.\n \n - procedureName : pn (unicode) [create]\n Used with -instrumentMel to specify the name of the procedure to be enabled/disabled the instrumentation.\n \n - removeCategory : rc (unicode) [create]\n Remove an existing category for the profiler. Returns the index of the removed category.\n \n - reset : r (bool) [create,query]\n reset the profiler's data (requires that sampling is off)\n \n - sampling : s (bool) [create,query]\n Toggled : Enable/disable the recording of events Query : return if the recording of events is On.\n \n - signalEvent : sig (bool) [query]\n Query if the event at the given index is a signal event. Requires the -eventIndex flag to specify the event to be\n queried. A Signal Event only remembers the start moment and has no knowledge about duration. It can be used in cases\n when the user does not care about the duration but only cares if this event does happen.\n \n - signalMelEvent : sim (bool) [create]\n Used with -instrumentMel true, inform profiler that this instrumented MEL command or procedure will be taken as a signal\n event during profiling. A Signal Event only remembers the start moment and has no knowledge about duration. It can be\n used in cases when the user does not care about the duration but only cares if this event does happen.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.profiler`\n "
pass
|
def profiler(*args, **kwargs):
"\n The profiler is used to record timing information from key events within Maya, as an aid in tuning the performance of\n scenes, scripts and plug-ins. User written plug-ins and Python scripts can also generate profiling information for their\n own code through the MProfilingScope and MProfiler classes in the API. This command provides the ability to control the\n collection of profiling data and to query information about the recorded events. The recorded information can also be\n viewed graphically in the Profiler window. The buffer size cannot be changed while sampling is active, it will return an\n error The reset flag cannot be called while sampling is active, it will return an error. Any changes to the buffer size\n will only be applied on start of the next recording. You can't save and load in the same command, save has priority,\n load would be ignored. In query mode, return type is based on queried flag.\n \n Flags:\n - addCategory : a (unicode) [create]\n Add a new category for the profiler. Returns the index of the new category.\n \n - allCategories : ac (bool) [query]\n Query the names of all categories\n \n - bufferSize : b (int) [create,query]\n Toggled : change the buffer size to fit the specified number of events (requires that sampling is off) Query : return\n the current buffer size The new buffer size will only take effect when next sampling starts. When the buffer is full,\n the recording stops.\n \n - categoryIndex : ci (int) [create,query]\n Used in conjunction with other flags, to indicate the index of the category.\n \n - categoryIndexToName : cin (int) [create,query]\n Returns the name of the category with a given index.\n \n - categoryName : cn (unicode) [query]\n Used in conjunction with other flags, to indicate the name of the category.\n \n - categoryNameToIndex : cni (unicode) [create,query]\n Returns the index of the category with a given name.\n \n - categoryRecording : cr (bool) [create,query]\n Toggled : Enable/disable the recording of the category. Query : return if the recording of the category is On. Requires\n the -categoryIndex or -categoryName flag to specify the category to be queried.\n \n - clearAllMelInstrumentation : cam (bool) [create]\n Clear all MEL command or procedure instrumentation.\n \n - colorIndex : coi (int) [create]\n Used with -instrumentMel trueto specify the color index to show the profiling result.\n \n - eventCPUId : eci (bool) [query]\n Query the CPU ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventCategory : eca (bool) [query]\n Query the category index the event at the given index belongs to. Requires the -eventIndex flag to specify the event to\n be queried.\n \n - eventColor : eco (bool) [query]\n Query the color of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventCount : ec (bool) [query]\n Query the number of events in the buffer\n \n - eventDescription : ed (bool) [query]\n Query the description of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventDuration : edu (bool) [query]\n Query the duration of the event at the given index, the time unit is microsecond. Note that a signal event has a 0\n duration. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventIndex : ei (int) [query]\n Used usually in conjunction with other flags, to indicate the index of the event.\n \n - eventName : en (bool) [query]\n Query the name of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - eventStartTime : et (bool) [query]\n Query the time of the event at the given index, the time unit is microsecond. Requires the -eventIndex flag to specify\n the event to be queried.\n \n - eventThreadId : eti (bool) [query]\n Query the thread ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.\n \n - instrumentMel : instrumentMel (bool) [create]\n Enable/Diable the instrumentation of a MEL command or procedure. When the instrumentation is enabled, the execution of\n MEL command or procedure can be profiled and shown in the Profiler window. To enable the instrumentation requires the\n -procedureName, -colorIndex and -categoryIndex flags. To disable the instrumentation requires the -procedureName flag.\n \n - load : l (unicode) [create,query]\n Read the recorded events from the specified file\n \n - output : o (unicode) [create,query]\n Output the recorded events to the specified file\n \n - procedureDescription : pd (unicode) [create]\n Used with -instrumentMel trueto provide a description of the MEL command or procedure being instrumented. This\n description can be viewed in the Profiler Tool window.\n \n - procedureName : pn (unicode) [create]\n Used with -instrumentMel to specify the name of the procedure to be enabled/disabled the instrumentation.\n \n - removeCategory : rc (unicode) [create]\n Remove an existing category for the profiler. Returns the index of the removed category.\n \n - reset : r (bool) [create,query]\n reset the profiler's data (requires that sampling is off)\n \n - sampling : s (bool) [create,query]\n Toggled : Enable/disable the recording of events Query : return if the recording of events is On.\n \n - signalEvent : sig (bool) [query]\n Query if the event at the given index is a signal event. Requires the -eventIndex flag to specify the event to be\n queried. A Signal Event only remembers the start moment and has no knowledge about duration. It can be used in cases\n when the user does not care about the duration but only cares if this event does happen.\n \n - signalMelEvent : sim (bool) [create]\n Used with -instrumentMel true, inform profiler that this instrumented MEL command or procedure will be taken as a signal\n event during profiling. A Signal Event only remembers the start moment and has no knowledge about duration. It can be\n used in cases when the user does not care about the duration but only cares if this event does happen.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.profiler`\n "
pass<|docstring|>The profiler is used to record timing information from key events within Maya, as an aid in tuning the performance of
scenes, scripts and plug-ins. User written plug-ins and Python scripts can also generate profiling information for their
own code through the MProfilingScope and MProfiler classes in the API. This command provides the ability to control the
collection of profiling data and to query information about the recorded events. The recorded information can also be
viewed graphically in the Profiler window. The buffer size cannot be changed while sampling is active, it will return an
error The reset flag cannot be called while sampling is active, it will return an error. Any changes to the buffer size
will only be applied on start of the next recording. You can't save and load in the same command, save has priority,
load would be ignored. In query mode, return type is based on queried flag.
Flags:
- addCategory : a (unicode) [create]
Add a new category for the profiler. Returns the index of the new category.
- allCategories : ac (bool) [query]
Query the names of all categories
- bufferSize : b (int) [create,query]
Toggled : change the buffer size to fit the specified number of events (requires that sampling is off) Query : return
the current buffer size The new buffer size will only take effect when next sampling starts. When the buffer is full,
the recording stops.
- categoryIndex : ci (int) [create,query]
Used in conjunction with other flags, to indicate the index of the category.
- categoryIndexToName : cin (int) [create,query]
Returns the name of the category with a given index.
- categoryName : cn (unicode) [query]
Used in conjunction with other flags, to indicate the name of the category.
- categoryNameToIndex : cni (unicode) [create,query]
Returns the index of the category with a given name.
- categoryRecording : cr (bool) [create,query]
Toggled : Enable/disable the recording of the category. Query : return if the recording of the category is On. Requires
the -categoryIndex or -categoryName flag to specify the category to be queried.
- clearAllMelInstrumentation : cam (bool) [create]
Clear all MEL command or procedure instrumentation.
- colorIndex : coi (int) [create]
Used with -instrumentMel trueto specify the color index to show the profiling result.
- eventCPUId : eci (bool) [query]
Query the CPU ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventCategory : eca (bool) [query]
Query the category index the event at the given index belongs to. Requires the -eventIndex flag to specify the event to
be queried.
- eventColor : eco (bool) [query]
Query the color of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventCount : ec (bool) [query]
Query the number of events in the buffer
- eventDescription : ed (bool) [query]
Query the description of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventDuration : edu (bool) [query]
Query the duration of the event at the given index, the time unit is microsecond. Note that a signal event has a 0
duration. Requires the -eventIndex flag to specify the event to be queried.
- eventIndex : ei (int) [query]
Used usually in conjunction with other flags, to indicate the index of the event.
- eventName : en (bool) [query]
Query the name of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- eventStartTime : et (bool) [query]
Query the time of the event at the given index, the time unit is microsecond. Requires the -eventIndex flag to specify
the event to be queried.
- eventThreadId : eti (bool) [query]
Query the thread ID of the event at the given index. Requires the -eventIndex flag to specify the event to be queried.
- instrumentMel : instrumentMel (bool) [create]
Enable/Diable the instrumentation of a MEL command or procedure. When the instrumentation is enabled, the execution of
MEL command or procedure can be profiled and shown in the Profiler window. To enable the instrumentation requires the
-procedureName, -colorIndex and -categoryIndex flags. To disable the instrumentation requires the -procedureName flag.
- load : l (unicode) [create,query]
Read the recorded events from the specified file
- output : o (unicode) [create,query]
Output the recorded events to the specified file
- procedureDescription : pd (unicode) [create]
Used with -instrumentMel trueto provide a description of the MEL command or procedure being instrumented. This
description can be viewed in the Profiler Tool window.
- procedureName : pn (unicode) [create]
Used with -instrumentMel to specify the name of the procedure to be enabled/disabled the instrumentation.
- removeCategory : rc (unicode) [create]
Remove an existing category for the profiler. Returns the index of the removed category.
- reset : r (bool) [create,query]
reset the profiler's data (requires that sampling is off)
- sampling : s (bool) [create,query]
Toggled : Enable/disable the recording of events Query : return if the recording of events is On.
- signalEvent : sig (bool) [query]
Query if the event at the given index is a signal event. Requires the -eventIndex flag to specify the event to be
queried. A Signal Event only remembers the start moment and has no knowledge about duration. It can be used in cases
when the user does not care about the duration but only cares if this event does happen.
- signalMelEvent : sim (bool) [create]
Used with -instrumentMel true, inform profiler that this instrumented MEL command or procedure will be taken as a signal
event during profiling. A Signal Event only remembers the start moment and has no knowledge about duration. It can be
used in cases when the user does not care about the duration but only cares if this event does happen.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.profiler`<|endoftext|>
|
3732a73b5df20b1e883791c5e5376386ca168da9131eb2fdef7573c743d8afea
|
def dirmap(*args, **kwargs):
"\n Use this command to map a directory to another directory. The first argument is the directory to map, and the second is\n the destination directory to map to. Directories must both be absolute paths, and should be separated with forward\n slashes ('/'). The mapping is case-sensitive on all platforms. This command can be useful when moving projects to\n another machine where some textures may not be contained in the Maya project, or when a texture archive moves to a new\n location. This command is not necessary when moving a (self-contained) project from one machine to another - instead\n copy the entire project over and set the Maya project to the new location. For one-time directory moves, if the command\n is enabled and the mapping configured correctly, when a scene is opened and saved the mapped locations will be reflected\n in the filenames saved with the file. To set up a permanent mapping the command should be enabled and the mappings set\n up in a script which is executed every time you launch Maya (userSetup.mel is sourced on startup). The directory\n mappings and enabled state are not preserved between Maya sessions. This command requires one mainflag that specifies\n the action to take. Flags are:-[m|um|gmd|gam|cd|en]\n \n Flags:\n - convertDirectory : cd (unicode) [create]\n Convert a file or directory. Returns the name of the mapped file or directory, if the command is enabled. If the given\n string contains one of the mapped directories, the return value will have that substring replaced with the mapped one.\n Otherwise the given argument string will be returned. If the command is disabled the given argument is always returned.\n Checks are not made for whether the file or directory exists. If the given string is a directory it should have a\n trailing '/'.\n \n - enable : en (bool) [create,query]\n Enable directory mapping. Directory mapping is off when you start Maya. If enabled, when opening Maya scenes, file\n texture paths (and other file paths) will be converted when the scene is opened. The -cd flag only returns mapped\n directories when -enable is true. Query returns whether mapping has been enabled.\n \n - getAllMappings : gam (bool) [create]\n Get all current mappings. Returns string array of current mappings in format: [redirect1, replacement1, ... redirectN,\n replacementN]\n \n - getMappedDirectory : gmd (unicode) [create]\n Get the mapped redirected directory. The given argument must exactly match the first string used with the -mapDirectory\n flag.\n \n - mapDirectory : m (unicode, unicode) [create]\n Map a directory - the first argument is mapped to the second. Neither directory needs to exist on the local machine at\n the time of invocation.\n \n - unmapDirectory : um (unicode) [create]\n Unmap a directory. The given argument must exactly match the argument used with the -mapDirectory flag.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dirmap`\n "
pass
|
Use this command to map a directory to another directory. The first argument is the directory to map, and the second is
the destination directory to map to. Directories must both be absolute paths, and should be separated with forward
slashes ('/'). The mapping is case-sensitive on all platforms. This command can be useful when moving projects to
another machine where some textures may not be contained in the Maya project, or when a texture archive moves to a new
location. This command is not necessary when moving a (self-contained) project from one machine to another - instead
copy the entire project over and set the Maya project to the new location. For one-time directory moves, if the command
is enabled and the mapping configured correctly, when a scene is opened and saved the mapped locations will be reflected
in the filenames saved with the file. To set up a permanent mapping the command should be enabled and the mappings set
up in a script which is executed every time you launch Maya (userSetup.mel is sourced on startup). The directory
mappings and enabled state are not preserved between Maya sessions. This command requires one mainflag that specifies
the action to take. Flags are:-[m|um|gmd|gam|cd|en]
Flags:
- convertDirectory : cd (unicode) [create]
Convert a file or directory. Returns the name of the mapped file or directory, if the command is enabled. If the given
string contains one of the mapped directories, the return value will have that substring replaced with the mapped one.
Otherwise the given argument string will be returned. If the command is disabled the given argument is always returned.
Checks are not made for whether the file or directory exists. If the given string is a directory it should have a
trailing '/'.
- enable : en (bool) [create,query]
Enable directory mapping. Directory mapping is off when you start Maya. If enabled, when opening Maya scenes, file
texture paths (and other file paths) will be converted when the scene is opened. The -cd flag only returns mapped
directories when -enable is true. Query returns whether mapping has been enabled.
- getAllMappings : gam (bool) [create]
Get all current mappings. Returns string array of current mappings in format: [redirect1, replacement1, ... redirectN,
replacementN]
- getMappedDirectory : gmd (unicode) [create]
Get the mapped redirected directory. The given argument must exactly match the first string used with the -mapDirectory
flag.
- mapDirectory : m (unicode, unicode) [create]
Map a directory - the first argument is mapped to the second. Neither directory needs to exist on the local machine at
the time of invocation.
- unmapDirectory : um (unicode) [create]
Unmap a directory. The given argument must exactly match the argument used with the -mapDirectory flag.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dirmap`
|
mayaSDK/pymel/core/system.py
|
dirmap
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def dirmap(*args, **kwargs):
"\n Use this command to map a directory to another directory. The first argument is the directory to map, and the second is\n the destination directory to map to. Directories must both be absolute paths, and should be separated with forward\n slashes ('/'). The mapping is case-sensitive on all platforms. This command can be useful when moving projects to\n another machine where some textures may not be contained in the Maya project, or when a texture archive moves to a new\n location. This command is not necessary when moving a (self-contained) project from one machine to another - instead\n copy the entire project over and set the Maya project to the new location. For one-time directory moves, if the command\n is enabled and the mapping configured correctly, when a scene is opened and saved the mapped locations will be reflected\n in the filenames saved with the file. To set up a permanent mapping the command should be enabled and the mappings set\n up in a script which is executed every time you launch Maya (userSetup.mel is sourced on startup). The directory\n mappings and enabled state are not preserved between Maya sessions. This command requires one mainflag that specifies\n the action to take. Flags are:-[m|um|gmd|gam|cd|en]\n \n Flags:\n - convertDirectory : cd (unicode) [create]\n Convert a file or directory. Returns the name of the mapped file or directory, if the command is enabled. If the given\n string contains one of the mapped directories, the return value will have that substring replaced with the mapped one.\n Otherwise the given argument string will be returned. If the command is disabled the given argument is always returned.\n Checks are not made for whether the file or directory exists. If the given string is a directory it should have a\n trailing '/'.\n \n - enable : en (bool) [create,query]\n Enable directory mapping. Directory mapping is off when you start Maya. If enabled, when opening Maya scenes, file\n texture paths (and other file paths) will be converted when the scene is opened. The -cd flag only returns mapped\n directories when -enable is true. Query returns whether mapping has been enabled.\n \n - getAllMappings : gam (bool) [create]\n Get all current mappings. Returns string array of current mappings in format: [redirect1, replacement1, ... redirectN,\n replacementN]\n \n - getMappedDirectory : gmd (unicode) [create]\n Get the mapped redirected directory. The given argument must exactly match the first string used with the -mapDirectory\n flag.\n \n - mapDirectory : m (unicode, unicode) [create]\n Map a directory - the first argument is mapped to the second. Neither directory needs to exist on the local machine at\n the time of invocation.\n \n - unmapDirectory : um (unicode) [create]\n Unmap a directory. The given argument must exactly match the argument used with the -mapDirectory flag.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dirmap`\n "
pass
|
def dirmap(*args, **kwargs):
"\n Use this command to map a directory to another directory. The first argument is the directory to map, and the second is\n the destination directory to map to. Directories must both be absolute paths, and should be separated with forward\n slashes ('/'). The mapping is case-sensitive on all platforms. This command can be useful when moving projects to\n another machine where some textures may not be contained in the Maya project, or when a texture archive moves to a new\n location. This command is not necessary when moving a (self-contained) project from one machine to another - instead\n copy the entire project over and set the Maya project to the new location. For one-time directory moves, if the command\n is enabled and the mapping configured correctly, when a scene is opened and saved the mapped locations will be reflected\n in the filenames saved with the file. To set up a permanent mapping the command should be enabled and the mappings set\n up in a script which is executed every time you launch Maya (userSetup.mel is sourced on startup). The directory\n mappings and enabled state are not preserved between Maya sessions. This command requires one mainflag that specifies\n the action to take. Flags are:-[m|um|gmd|gam|cd|en]\n \n Flags:\n - convertDirectory : cd (unicode) [create]\n Convert a file or directory. Returns the name of the mapped file or directory, if the command is enabled. If the given\n string contains one of the mapped directories, the return value will have that substring replaced with the mapped one.\n Otherwise the given argument string will be returned. If the command is disabled the given argument is always returned.\n Checks are not made for whether the file or directory exists. If the given string is a directory it should have a\n trailing '/'.\n \n - enable : en (bool) [create,query]\n Enable directory mapping. Directory mapping is off when you start Maya. If enabled, when opening Maya scenes, file\n texture paths (and other file paths) will be converted when the scene is opened. The -cd flag only returns mapped\n directories when -enable is true. Query returns whether mapping has been enabled.\n \n - getAllMappings : gam (bool) [create]\n Get all current mappings. Returns string array of current mappings in format: [redirect1, replacement1, ... redirectN,\n replacementN]\n \n - getMappedDirectory : gmd (unicode) [create]\n Get the mapped redirected directory. The given argument must exactly match the first string used with the -mapDirectory\n flag.\n \n - mapDirectory : m (unicode, unicode) [create]\n Map a directory - the first argument is mapped to the second. Neither directory needs to exist on the local machine at\n the time of invocation.\n \n - unmapDirectory : um (unicode) [create]\n Unmap a directory. The given argument must exactly match the argument used with the -mapDirectory flag.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dirmap`\n "
pass<|docstring|>Use this command to map a directory to another directory. The first argument is the directory to map, and the second is
the destination directory to map to. Directories must both be absolute paths, and should be separated with forward
slashes ('/'). The mapping is case-sensitive on all platforms. This command can be useful when moving projects to
another machine where some textures may not be contained in the Maya project, or when a texture archive moves to a new
location. This command is not necessary when moving a (self-contained) project from one machine to another - instead
copy the entire project over and set the Maya project to the new location. For one-time directory moves, if the command
is enabled and the mapping configured correctly, when a scene is opened and saved the mapped locations will be reflected
in the filenames saved with the file. To set up a permanent mapping the command should be enabled and the mappings set
up in a script which is executed every time you launch Maya (userSetup.mel is sourced on startup). The directory
mappings and enabled state are not preserved between Maya sessions. This command requires one mainflag that specifies
the action to take. Flags are:-[m|um|gmd|gam|cd|en]
Flags:
- convertDirectory : cd (unicode) [create]
Convert a file or directory. Returns the name of the mapped file or directory, if the command is enabled. If the given
string contains one of the mapped directories, the return value will have that substring replaced with the mapped one.
Otherwise the given argument string will be returned. If the command is disabled the given argument is always returned.
Checks are not made for whether the file or directory exists. If the given string is a directory it should have a
trailing '/'.
- enable : en (bool) [create,query]
Enable directory mapping. Directory mapping is off when you start Maya. If enabled, when opening Maya scenes, file
texture paths (and other file paths) will be converted when the scene is opened. The -cd flag only returns mapped
directories when -enable is true. Query returns whether mapping has been enabled.
- getAllMappings : gam (bool) [create]
Get all current mappings. Returns string array of current mappings in format: [redirect1, replacement1, ... redirectN,
replacementN]
- getMappedDirectory : gmd (unicode) [create]
Get the mapped redirected directory. The given argument must exactly match the first string used with the -mapDirectory
flag.
- mapDirectory : m (unicode, unicode) [create]
Map a directory - the first argument is mapped to the second. Neither directory needs to exist on the local machine at
the time of invocation.
- unmapDirectory : um (unicode) [create]
Unmap a directory. The given argument must exactly match the argument used with the -mapDirectory flag.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dirmap`<|endoftext|>
|
48bf4e78a9a1330019767ddb3576c99ee8a5bcd183770f3c097639bc0bad2c6e
|
def xpmPicker(*args, **kwargs):
'\n Open a dialog and ask you to choose a xpm file\n \n Flags:\n - fileName : fn (unicode) [create]\n default filename to display in dialog\n \n - parent : p (unicode) [create]\n parent window for modal dialog Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.xpmPicker`\n '
pass
|
Open a dialog and ask you to choose a xpm file
Flags:
- fileName : fn (unicode) [create]
default filename to display in dialog
- parent : p (unicode) [create]
parent window for modal dialog Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.xpmPicker`
|
mayaSDK/pymel/core/system.py
|
xpmPicker
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def xpmPicker(*args, **kwargs):
'\n Open a dialog and ask you to choose a xpm file\n \n Flags:\n - fileName : fn (unicode) [create]\n default filename to display in dialog\n \n - parent : p (unicode) [create]\n parent window for modal dialog Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.xpmPicker`\n '
pass
|
def xpmPicker(*args, **kwargs):
'\n Open a dialog and ask you to choose a xpm file\n \n Flags:\n - fileName : fn (unicode) [create]\n default filename to display in dialog\n \n - parent : p (unicode) [create]\n parent window for modal dialog Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.xpmPicker`\n '
pass<|docstring|>Open a dialog and ask you to choose a xpm file
Flags:
- fileName : fn (unicode) [create]
default filename to display in dialog
- parent : p (unicode) [create]
parent window for modal dialog Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.xpmPicker`<|endoftext|>
|
b70e160485872a1596afc0ac9908178bf73682f982c3e1bc79348990111253d5
|
def dagObjectCompare(*args, **kwargs):
"\n dagObjectCompare can be used to compare to compare objects based on: type - Currently supports transform nodes and\n shape nodesrelatives - Compares DAG objects' children and parentsconnections - Checks to make sure the two dags are\n connected to the same sources and destinationsattributes - Checks to make sure that the properties of active attributes\n are the same\n \n Flags:\n - attribute : a (bool) [create]\n Compare dag object attributes\n \n - bail : b (unicode) [create]\n Bail on first error or bail on category. Legal values are never, first, and category.\n \n - connection : c (bool) [create]\n Compare dag connections\n \n - namespace : n (unicode) [create]\n The baseline namespace\n \n - relative : r (bool) [create]\n dag relatives\n \n - short : s (bool) [create]\n Compress output to short form (not as verbose)\n \n - type : t (bool) [create]\n Compare based on dag object type Flag can have multiple arguments, passed either as a\n tuple or a list.\n \n \n Derived from mel command `maya.cmds.dagObjectCompare`\n "
pass
|
dagObjectCompare can be used to compare to compare objects based on: type - Currently supports transform nodes and
shape nodesrelatives - Compares DAG objects' children and parentsconnections - Checks to make sure the two dags are
connected to the same sources and destinationsattributes - Checks to make sure that the properties of active attributes
are the same
Flags:
- attribute : a (bool) [create]
Compare dag object attributes
- bail : b (unicode) [create]
Bail on first error or bail on category. Legal values are never, first, and category.
- connection : c (bool) [create]
Compare dag connections
- namespace : n (unicode) [create]
The baseline namespace
- relative : r (bool) [create]
dag relatives
- short : s (bool) [create]
Compress output to short form (not as verbose)
- type : t (bool) [create]
Compare based on dag object type Flag can have multiple arguments, passed either as a
tuple or a list.
Derived from mel command `maya.cmds.dagObjectCompare`
|
mayaSDK/pymel/core/system.py
|
dagObjectCompare
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def dagObjectCompare(*args, **kwargs):
"\n dagObjectCompare can be used to compare to compare objects based on: type - Currently supports transform nodes and\n shape nodesrelatives - Compares DAG objects' children and parentsconnections - Checks to make sure the two dags are\n connected to the same sources and destinationsattributes - Checks to make sure that the properties of active attributes\n are the same\n \n Flags:\n - attribute : a (bool) [create]\n Compare dag object attributes\n \n - bail : b (unicode) [create]\n Bail on first error or bail on category. Legal values are never, first, and category.\n \n - connection : c (bool) [create]\n Compare dag connections\n \n - namespace : n (unicode) [create]\n The baseline namespace\n \n - relative : r (bool) [create]\n dag relatives\n \n - short : s (bool) [create]\n Compress output to short form (not as verbose)\n \n - type : t (bool) [create]\n Compare based on dag object type Flag can have multiple arguments, passed either as a\n tuple or a list.\n \n \n Derived from mel command `maya.cmds.dagObjectCompare`\n "
pass
|
def dagObjectCompare(*args, **kwargs):
"\n dagObjectCompare can be used to compare to compare objects based on: type - Currently supports transform nodes and\n shape nodesrelatives - Compares DAG objects' children and parentsconnections - Checks to make sure the two dags are\n connected to the same sources and destinationsattributes - Checks to make sure that the properties of active attributes\n are the same\n \n Flags:\n - attribute : a (bool) [create]\n Compare dag object attributes\n \n - bail : b (unicode) [create]\n Bail on first error or bail on category. Legal values are never, first, and category.\n \n - connection : c (bool) [create]\n Compare dag connections\n \n - namespace : n (unicode) [create]\n The baseline namespace\n \n - relative : r (bool) [create]\n dag relatives\n \n - short : s (bool) [create]\n Compress output to short form (not as verbose)\n \n - type : t (bool) [create]\n Compare based on dag object type Flag can have multiple arguments, passed either as a\n tuple or a list.\n \n \n Derived from mel command `maya.cmds.dagObjectCompare`\n "
pass<|docstring|>dagObjectCompare can be used to compare to compare objects based on: type - Currently supports transform nodes and
shape nodesrelatives - Compares DAG objects' children and parentsconnections - Checks to make sure the two dags are
connected to the same sources and destinationsattributes - Checks to make sure that the properties of active attributes
are the same
Flags:
- attribute : a (bool) [create]
Compare dag object attributes
- bail : b (unicode) [create]
Bail on first error or bail on category. Legal values are never, first, and category.
- connection : c (bool) [create]
Compare dag connections
- namespace : n (unicode) [create]
The baseline namespace
- relative : r (bool) [create]
dag relatives
- short : s (bool) [create]
Compress output to short form (not as verbose)
- type : t (bool) [create]
Compare based on dag object type Flag can have multiple arguments, passed either as a
tuple or a list.
Derived from mel command `maya.cmds.dagObjectCompare`<|endoftext|>
|
b42c88d2aaa9c0f5faf6c9d0b06b108a8f5ee72fac97fdca06016b8e91b6452d
|
def listNamespaces_old():
"\n Deprecated\n Returns a list of the namespaces of referenced files.\n REMOVE In Favor of listReferences('dict') ?\n "
pass
|
Deprecated
Returns a list of the namespaces of referenced files.
REMOVE In Favor of listReferences('dict') ?
|
mayaSDK/pymel/core/system.py
|
listNamespaces_old
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def listNamespaces_old():
"\n Deprecated\n Returns a list of the namespaces of referenced files.\n REMOVE In Favor of listReferences('dict') ?\n "
pass
|
def listNamespaces_old():
"\n Deprecated\n Returns a list of the namespaces of referenced files.\n REMOVE In Favor of listReferences('dict') ?\n "
pass<|docstring|>Deprecated
Returns a list of the namespaces of referenced files.
REMOVE In Favor of listReferences('dict') ?<|endoftext|>
|
268b23c1be78d1ec9f17c77c0d1bee5aed253779877da32ace0c7e56eaf5f3df
|
def cacheFile(*args, **kwargs):
"\n Creates one or more cache files on disk to store attribute data for a span of frames. The caches can be created for\n points/normals on a geometry (using the pts/points or pan/pointsAndNormals flag), for vectorArray output data (using the\n oa/outAttr flag), or for additional node specific data (using the cnd/cacheableNode flag for those nodes that support\n it). When the ia/inAttr flag is used, connects a cacheFile node that associates the data file on disk with the\n attribute. Frames can be replaced/appended to an existing cache with the rcf/replaceCachedFrame and apf/appendFrame\n flag. Replaced frames are never deleted. They are stored in the same directory as the original cache files with the\n name provided by the f/fileName flag. If no file name is provided, the cacheFile name is prefixed with backupfollowed by\n a unique number. Single file caches are backed up in their entirety. To revert to an older version, simply attach to\n this cache. One file per frame caches only backup the description file and the frames that were replaced. To recover\n these types of caches, the user must rename these files to the original name.\n \n Flags:\n - appendFrame : apf (bool) [create]\n Appends data to the cache for the times specified by the startTime and endTime flags. If no time is provided, appends\n the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Any overwritten frames will\n not be deleted, but renamed as specified by the f/fileName flag.\n \n - attachFile : af (bool) [create]\n Used to indicate that rather than creating a cache file, that an existing cache file on disk should be attached to an\n attribute in the scene. The inAttr flag is used to specify the attribute.\n \n - cacheFileNode : cfn (unicode) [create]\n Specifies the name of the cache file node(s) we are appending/replacing to if more than one cache is attached to the\n specified geometries.\n \n - cacheFormat : cf (unicode) [create,query]\n Cache file format, default is Maya's .mcx format, but others available via plugin\n \n - cacheInfo : ci (unicode) [create,query]\n In create mode, used to specify a mel script returning a string array. When creating the cache, this mel script will be\n executed and the returned strings will be written to the .xml description file of the cache. In query mode, returns\n descriptive info stored in the cacheFile such as the user name, Maya scene name and maya version number.\n \n - cacheableAttrs : cat (unicode) [query]\n Returns the list of cacheable attributes defined on the accompanying cache node. This argument requires the use of the\n cacheableNode flag.\n \n - cacheableNode : cnd (unicode) [create]\n Specifies the name of a cacheable node whose contents will be cached. A cacheable node is a node that is specially\n designed to work with the caching mechanism. An example of a cacheable node is a nCloth node.\n \n - channelIndex : chi (bool) [create,query]\n A query-only flag which returns the channel index for the selected geometry for the cacheFile node specified using the\n cacheFileNode flag.\n \n - channelName : cnm (unicode) [create,query]\n When attachFile is used, used to indicate the channel in the file that should be attached to inAttr. If not specified,\n the first channel in the file is used. In query mode, allows user to query the channels associated with a description\n file.\n \n - convertPc2 : pc2 (bool) [create]\n Convert a PC2 file to the Maya cache format (true), or convert Maya cache to pc2 format (false)\n \n - createCacheNode : ccn (bool) [create]\n Used to indicate that rather than creating a cache file, that a cacheFile node should be created related to an existing\n cache file on disk.\n \n - creationChannelName : cch (unicode) [create]\n When creating a new cache, this multi-use flag specifies the channels to be cached. The names come from the cacheable\n channel names defined by the object being cached. If this flag is not used when creating a cache, then all cacheable\n channels are cached.\n \n - dataSize : dsz (bool) [query]\n This is a query-only flag that returns the size of the data being cached per frame. This flag is to be used in\n conjunction with the cacheableNode, points, pointsAndNormals and outAttr flags.\n \n - deleteCachedFrame : dcf (bool) [create]\n Deletes cached data for the times specified by the startTime/endTime flags. If no time is provided, deletes the current\n frame. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Deleted frames will not be removed\n from disk, but renamed as specified by the f/fileName flag.\n \n - descriptionFileName : dfn (bool) [query]\n This is a query-only flag that returns the name of the description file for an existing cacheFile node. Or if no\n cacheFile node is specified, it returns the description file name that would be created based on the other flags\n specified.\n \n - directory : dir (unicode) [create,query]\n Specifies the directory where the cache files will be located. If the directory flag is not specified, the cache files\n will be placed in the project data directory.\n \n - doubleToFloat : dtf (bool) [create]\n During cache creation, double data is stored in the file as floats. This helps cut down file size.\n \n - endTime : et (time) [create]\n Specifies the end frame of the cache range.\n \n - fileName : f (unicode) [create,query]\n Specifies the base file name for the cache files. If more than one object is being cached and the format is\n OneFilePerFrame, each cache file will be prefixed with this base file name. In query mode, returns the files associated\n with the specified cacheFile node. When used with rpf/replaceCachedFrame or apf/appendFrame specifies the name of the\n backup files. If not specified, replaced frames will be stored with a default name. In query mode, this flag can accept\n a value.\n \n - format : fm (unicode) [create]\n Specifies the distribution format of the cache. Valid values are OneFileand OneFilePerFrame\n \n - geometry : gm (bool) [query]\n A query flag which returns the geometry controlled by the specified cache node\n \n - inAttr : ia (unicode) [create]\n Specifies the name of the attribute that the cache file will drive. This file is optional when creating cache files. If\n this flag is not used during create mode, the cache files will be created on disk, but will not be driving anything in\n the scene. This flag is required when the attachFile flag is used.\n \n - inTangent : it (unicode) [create]\n Specifies the in-tangent type when interpolating frames before the replaced frame(s). Must be used with the\n ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.\n \n - interpEndTime : iet (time) [create]\n Specifies the frame until which there will be linear interpolation, beginning at endTime. Must be used with the\n rpf/replaceCachedFrame or apf/appendFrame flag. Interpolation is achieved by removing frames between endTime and\n interpEndTime from the cache. Removed frames will be renamed as specified by the f/fileName flag.\n \n - interpStartTime : ist (time) [create]\n Specifies the frame from which to begin linear interpolation, ending at startTime. Must be used with the\n rpf/replaceCachedFrame or apf/appendFrame flags. Interpolation is achieved by removing frames between interpStartTime\n and startTime from the cache. These removed frames will will be renamed as specified by the f/fileName flag.\n \n - noBackup : nb (bool) [create]\n Specifies that backup files should not be created for any files that may be over-written during append, replace or\n delete cache frames. Can only be used with the apf/appendFrame, rpf/replaceCachedFrame or dcf/deleteCachedFrame flags.\n \n - outAttr : oa (unicode) [create]\n Specifies the name of the attribute that will be cached to disk.\n \n - outTangent : ot (unicode) [create]\n Specifies the out-tangent type when interpolating frames after the replaced frame(s). Must be used with the\n ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.\n \n - pc2File : pcf (unicode) [create]\n Specifies the full path to the pc2 file. Must be used in conjunction with the pc2 flag.\n \n - pointCount : pc (bool) [query]\n A query flag which returns the number of points stored in the cache file. The channelName flag should be used to specify\n the channel to be queried.\n \n - points : pts (unicode) [create]\n Specifies the name of a geometry whose points will be cached.\n \n - pointsAndNormals : pan (unicode) [create]\n Specifies the name of a geometry whose points and normals will be cached. The normals is per-vertex per-polygon. The\n normals cache cannot be imported back to geometry. This flag can only be used to export cache file. It cannot be used\n with the apf/appendFrame, dcf/deleteCachedFrame and rpf/replaceCachedFrame flags.\n \n - prefix : p (bool) [create]\n Indicates that the specified fileName should be used as a prefix for the cacheName.\n \n - refresh : r (bool) [create]\n When used during cache creation, forces a screen refresh during caching. This causes the cache creation to be slower but\n allows you to see how the simulation is progressing during the cache.\n \n - replaceCachedFrame : rcf (bool) [create]\n Replaces cached data for the times specified by the startTime/endTime flags. If no time is provided, replaces cache file\n for the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Replaced frames will\n not be deleted, but renamed as specified by the f/fileName flag.\n \n - replaceWithoutSimulating : rws (bool) [edit]\n When replacing cached frames, this flag specifies whether the replacement should come from the cached node without\n simulating or from advancing time and letting the simulation run. This flag is valid only when neither the startTime\n nor endTime flags are used or when both the startTime and endTime flags specify the same time value.\n \n - runupFrames : rf (int) [create,query,edit]\n Specifies the number of frames of runup to simulate ahead of the starting frame. The value must be greater than or equal\n to 0. The default is 2.\n \n - sampleMultiplier : spm (int) [create,query,edit]\n Specifies the sample rate when caches are being created as a multiple of simulation Rate. If the value is 1, then a\n sample will be cached everytime the time is advanced. If the value is 2, then every other sample will be cached, and so\n on. The default is 1.\n \n - simulationRate : smr (time) [create,query,edit]\n Specifies the simulation rate when caches are being created. During cache creation, the time will be advanced by the\n simulation rate, until the end time of the cache is reached or surpassed. The value is given in frames. The default\n value is 1 frame.\n \n - singleCache : sch (bool) [create]\n When used in conjunction with the points, pointsAndNormal or cacheableNode flag, specifies whether multiple geometries\n should be put into a single cache or to create one cache per geometry (default).\n \n - startTime : st (time) [create]\n Specifies the start frame of the cache range.\n \n - staticCache : sc (bool) [create,query]\n If false, during cache creation, do not save a cache for the object if it appears to have no animation or deformation.\n If true, save a cache even if the object appears to have no animation or deformation. Default is true. In query mode,\n when supplied a shape, the flag returns true if the shape appears to have no animation or deformation.\n \n - worldSpace : ws (bool) [create]\n If the points flag is used, turning on this flag will result in the world space positions of the points being written.\n The expected use of this flag is for cache export. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cacheFile`\n "
pass
|
Creates one or more cache files on disk to store attribute data for a span of frames. The caches can be created for
points/normals on a geometry (using the pts/points or pan/pointsAndNormals flag), for vectorArray output data (using the
oa/outAttr flag), or for additional node specific data (using the cnd/cacheableNode flag for those nodes that support
it). When the ia/inAttr flag is used, connects a cacheFile node that associates the data file on disk with the
attribute. Frames can be replaced/appended to an existing cache with the rcf/replaceCachedFrame and apf/appendFrame
flag. Replaced frames are never deleted. They are stored in the same directory as the original cache files with the
name provided by the f/fileName flag. If no file name is provided, the cacheFile name is prefixed with backupfollowed by
a unique number. Single file caches are backed up in their entirety. To revert to an older version, simply attach to
this cache. One file per frame caches only backup the description file and the frames that were replaced. To recover
these types of caches, the user must rename these files to the original name.
Flags:
- appendFrame : apf (bool) [create]
Appends data to the cache for the times specified by the startTime and endTime flags. If no time is provided, appends
the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Any overwritten frames will
not be deleted, but renamed as specified by the f/fileName flag.
- attachFile : af (bool) [create]
Used to indicate that rather than creating a cache file, that an existing cache file on disk should be attached to an
attribute in the scene. The inAttr flag is used to specify the attribute.
- cacheFileNode : cfn (unicode) [create]
Specifies the name of the cache file node(s) we are appending/replacing to if more than one cache is attached to the
specified geometries.
- cacheFormat : cf (unicode) [create,query]
Cache file format, default is Maya's .mcx format, but others available via plugin
- cacheInfo : ci (unicode) [create,query]
In create mode, used to specify a mel script returning a string array. When creating the cache, this mel script will be
executed and the returned strings will be written to the .xml description file of the cache. In query mode, returns
descriptive info stored in the cacheFile such as the user name, Maya scene name and maya version number.
- cacheableAttrs : cat (unicode) [query]
Returns the list of cacheable attributes defined on the accompanying cache node. This argument requires the use of the
cacheableNode flag.
- cacheableNode : cnd (unicode) [create]
Specifies the name of a cacheable node whose contents will be cached. A cacheable node is a node that is specially
designed to work with the caching mechanism. An example of a cacheable node is a nCloth node.
- channelIndex : chi (bool) [create,query]
A query-only flag which returns the channel index for the selected geometry for the cacheFile node specified using the
cacheFileNode flag.
- channelName : cnm (unicode) [create,query]
When attachFile is used, used to indicate the channel in the file that should be attached to inAttr. If not specified,
the first channel in the file is used. In query mode, allows user to query the channels associated with a description
file.
- convertPc2 : pc2 (bool) [create]
Convert a PC2 file to the Maya cache format (true), or convert Maya cache to pc2 format (false)
- createCacheNode : ccn (bool) [create]
Used to indicate that rather than creating a cache file, that a cacheFile node should be created related to an existing
cache file on disk.
- creationChannelName : cch (unicode) [create]
When creating a new cache, this multi-use flag specifies the channels to be cached. The names come from the cacheable
channel names defined by the object being cached. If this flag is not used when creating a cache, then all cacheable
channels are cached.
- dataSize : dsz (bool) [query]
This is a query-only flag that returns the size of the data being cached per frame. This flag is to be used in
conjunction with the cacheableNode, points, pointsAndNormals and outAttr flags.
- deleteCachedFrame : dcf (bool) [create]
Deletes cached data for the times specified by the startTime/endTime flags. If no time is provided, deletes the current
frame. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Deleted frames will not be removed
from disk, but renamed as specified by the f/fileName flag.
- descriptionFileName : dfn (bool) [query]
This is a query-only flag that returns the name of the description file for an existing cacheFile node. Or if no
cacheFile node is specified, it returns the description file name that would be created based on the other flags
specified.
- directory : dir (unicode) [create,query]
Specifies the directory where the cache files will be located. If the directory flag is not specified, the cache files
will be placed in the project data directory.
- doubleToFloat : dtf (bool) [create]
During cache creation, double data is stored in the file as floats. This helps cut down file size.
- endTime : et (time) [create]
Specifies the end frame of the cache range.
- fileName : f (unicode) [create,query]
Specifies the base file name for the cache files. If more than one object is being cached and the format is
OneFilePerFrame, each cache file will be prefixed with this base file name. In query mode, returns the files associated
with the specified cacheFile node. When used with rpf/replaceCachedFrame or apf/appendFrame specifies the name of the
backup files. If not specified, replaced frames will be stored with a default name. In query mode, this flag can accept
a value.
- format : fm (unicode) [create]
Specifies the distribution format of the cache. Valid values are OneFileand OneFilePerFrame
- geometry : gm (bool) [query]
A query flag which returns the geometry controlled by the specified cache node
- inAttr : ia (unicode) [create]
Specifies the name of the attribute that the cache file will drive. This file is optional when creating cache files. If
this flag is not used during create mode, the cache files will be created on disk, but will not be driving anything in
the scene. This flag is required when the attachFile flag is used.
- inTangent : it (unicode) [create]
Specifies the in-tangent type when interpolating frames before the replaced frame(s). Must be used with the
ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.
- interpEndTime : iet (time) [create]
Specifies the frame until which there will be linear interpolation, beginning at endTime. Must be used with the
rpf/replaceCachedFrame or apf/appendFrame flag. Interpolation is achieved by removing frames between endTime and
interpEndTime from the cache. Removed frames will be renamed as specified by the f/fileName flag.
- interpStartTime : ist (time) [create]
Specifies the frame from which to begin linear interpolation, ending at startTime. Must be used with the
rpf/replaceCachedFrame or apf/appendFrame flags. Interpolation is achieved by removing frames between interpStartTime
and startTime from the cache. These removed frames will will be renamed as specified by the f/fileName flag.
- noBackup : nb (bool) [create]
Specifies that backup files should not be created for any files that may be over-written during append, replace or
delete cache frames. Can only be used with the apf/appendFrame, rpf/replaceCachedFrame or dcf/deleteCachedFrame flags.
- outAttr : oa (unicode) [create]
Specifies the name of the attribute that will be cached to disk.
- outTangent : ot (unicode) [create]
Specifies the out-tangent type when interpolating frames after the replaced frame(s). Must be used with the
ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.
- pc2File : pcf (unicode) [create]
Specifies the full path to the pc2 file. Must be used in conjunction with the pc2 flag.
- pointCount : pc (bool) [query]
A query flag which returns the number of points stored in the cache file. The channelName flag should be used to specify
the channel to be queried.
- points : pts (unicode) [create]
Specifies the name of a geometry whose points will be cached.
- pointsAndNormals : pan (unicode) [create]
Specifies the name of a geometry whose points and normals will be cached. The normals is per-vertex per-polygon. The
normals cache cannot be imported back to geometry. This flag can only be used to export cache file. It cannot be used
with the apf/appendFrame, dcf/deleteCachedFrame and rpf/replaceCachedFrame flags.
- prefix : p (bool) [create]
Indicates that the specified fileName should be used as a prefix for the cacheName.
- refresh : r (bool) [create]
When used during cache creation, forces a screen refresh during caching. This causes the cache creation to be slower but
allows you to see how the simulation is progressing during the cache.
- replaceCachedFrame : rcf (bool) [create]
Replaces cached data for the times specified by the startTime/endTime flags. If no time is provided, replaces cache file
for the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Replaced frames will
not be deleted, but renamed as specified by the f/fileName flag.
- replaceWithoutSimulating : rws (bool) [edit]
When replacing cached frames, this flag specifies whether the replacement should come from the cached node without
simulating or from advancing time and letting the simulation run. This flag is valid only when neither the startTime
nor endTime flags are used or when both the startTime and endTime flags specify the same time value.
- runupFrames : rf (int) [create,query,edit]
Specifies the number of frames of runup to simulate ahead of the starting frame. The value must be greater than or equal
to 0. The default is 2.
- sampleMultiplier : spm (int) [create,query,edit]
Specifies the sample rate when caches are being created as a multiple of simulation Rate. If the value is 1, then a
sample will be cached everytime the time is advanced. If the value is 2, then every other sample will be cached, and so
on. The default is 1.
- simulationRate : smr (time) [create,query,edit]
Specifies the simulation rate when caches are being created. During cache creation, the time will be advanced by the
simulation rate, until the end time of the cache is reached or surpassed. The value is given in frames. The default
value is 1 frame.
- singleCache : sch (bool) [create]
When used in conjunction with the points, pointsAndNormal or cacheableNode flag, specifies whether multiple geometries
should be put into a single cache or to create one cache per geometry (default).
- startTime : st (time) [create]
Specifies the start frame of the cache range.
- staticCache : sc (bool) [create,query]
If false, during cache creation, do not save a cache for the object if it appears to have no animation or deformation.
If true, save a cache even if the object appears to have no animation or deformation. Default is true. In query mode,
when supplied a shape, the flag returns true if the shape appears to have no animation or deformation.
- worldSpace : ws (bool) [create]
If the points flag is used, turning on this flag will result in the world space positions of the points being written.
The expected use of this flag is for cache export. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.cacheFile`
|
mayaSDK/pymel/core/system.py
|
cacheFile
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def cacheFile(*args, **kwargs):
"\n Creates one or more cache files on disk to store attribute data for a span of frames. The caches can be created for\n points/normals on a geometry (using the pts/points or pan/pointsAndNormals flag), for vectorArray output data (using the\n oa/outAttr flag), or for additional node specific data (using the cnd/cacheableNode flag for those nodes that support\n it). When the ia/inAttr flag is used, connects a cacheFile node that associates the data file on disk with the\n attribute. Frames can be replaced/appended to an existing cache with the rcf/replaceCachedFrame and apf/appendFrame\n flag. Replaced frames are never deleted. They are stored in the same directory as the original cache files with the\n name provided by the f/fileName flag. If no file name is provided, the cacheFile name is prefixed with backupfollowed by\n a unique number. Single file caches are backed up in their entirety. To revert to an older version, simply attach to\n this cache. One file per frame caches only backup the description file and the frames that were replaced. To recover\n these types of caches, the user must rename these files to the original name.\n \n Flags:\n - appendFrame : apf (bool) [create]\n Appends data to the cache for the times specified by the startTime and endTime flags. If no time is provided, appends\n the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Any overwritten frames will\n not be deleted, but renamed as specified by the f/fileName flag.\n \n - attachFile : af (bool) [create]\n Used to indicate that rather than creating a cache file, that an existing cache file on disk should be attached to an\n attribute in the scene. The inAttr flag is used to specify the attribute.\n \n - cacheFileNode : cfn (unicode) [create]\n Specifies the name of the cache file node(s) we are appending/replacing to if more than one cache is attached to the\n specified geometries.\n \n - cacheFormat : cf (unicode) [create,query]\n Cache file format, default is Maya's .mcx format, but others available via plugin\n \n - cacheInfo : ci (unicode) [create,query]\n In create mode, used to specify a mel script returning a string array. When creating the cache, this mel script will be\n executed and the returned strings will be written to the .xml description file of the cache. In query mode, returns\n descriptive info stored in the cacheFile such as the user name, Maya scene name and maya version number.\n \n - cacheableAttrs : cat (unicode) [query]\n Returns the list of cacheable attributes defined on the accompanying cache node. This argument requires the use of the\n cacheableNode flag.\n \n - cacheableNode : cnd (unicode) [create]\n Specifies the name of a cacheable node whose contents will be cached. A cacheable node is a node that is specially\n designed to work with the caching mechanism. An example of a cacheable node is a nCloth node.\n \n - channelIndex : chi (bool) [create,query]\n A query-only flag which returns the channel index for the selected geometry for the cacheFile node specified using the\n cacheFileNode flag.\n \n - channelName : cnm (unicode) [create,query]\n When attachFile is used, used to indicate the channel in the file that should be attached to inAttr. If not specified,\n the first channel in the file is used. In query mode, allows user to query the channels associated with a description\n file.\n \n - convertPc2 : pc2 (bool) [create]\n Convert a PC2 file to the Maya cache format (true), or convert Maya cache to pc2 format (false)\n \n - createCacheNode : ccn (bool) [create]\n Used to indicate that rather than creating a cache file, that a cacheFile node should be created related to an existing\n cache file on disk.\n \n - creationChannelName : cch (unicode) [create]\n When creating a new cache, this multi-use flag specifies the channels to be cached. The names come from the cacheable\n channel names defined by the object being cached. If this flag is not used when creating a cache, then all cacheable\n channels are cached.\n \n - dataSize : dsz (bool) [query]\n This is a query-only flag that returns the size of the data being cached per frame. This flag is to be used in\n conjunction with the cacheableNode, points, pointsAndNormals and outAttr flags.\n \n - deleteCachedFrame : dcf (bool) [create]\n Deletes cached data for the times specified by the startTime/endTime flags. If no time is provided, deletes the current\n frame. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Deleted frames will not be removed\n from disk, but renamed as specified by the f/fileName flag.\n \n - descriptionFileName : dfn (bool) [query]\n This is a query-only flag that returns the name of the description file for an existing cacheFile node. Or if no\n cacheFile node is specified, it returns the description file name that would be created based on the other flags\n specified.\n \n - directory : dir (unicode) [create,query]\n Specifies the directory where the cache files will be located. If the directory flag is not specified, the cache files\n will be placed in the project data directory.\n \n - doubleToFloat : dtf (bool) [create]\n During cache creation, double data is stored in the file as floats. This helps cut down file size.\n \n - endTime : et (time) [create]\n Specifies the end frame of the cache range.\n \n - fileName : f (unicode) [create,query]\n Specifies the base file name for the cache files. If more than one object is being cached and the format is\n OneFilePerFrame, each cache file will be prefixed with this base file name. In query mode, returns the files associated\n with the specified cacheFile node. When used with rpf/replaceCachedFrame or apf/appendFrame specifies the name of the\n backup files. If not specified, replaced frames will be stored with a default name. In query mode, this flag can accept\n a value.\n \n - format : fm (unicode) [create]\n Specifies the distribution format of the cache. Valid values are OneFileand OneFilePerFrame\n \n - geometry : gm (bool) [query]\n A query flag which returns the geometry controlled by the specified cache node\n \n - inAttr : ia (unicode) [create]\n Specifies the name of the attribute that the cache file will drive. This file is optional when creating cache files. If\n this flag is not used during create mode, the cache files will be created on disk, but will not be driving anything in\n the scene. This flag is required when the attachFile flag is used.\n \n - inTangent : it (unicode) [create]\n Specifies the in-tangent type when interpolating frames before the replaced frame(s). Must be used with the\n ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.\n \n - interpEndTime : iet (time) [create]\n Specifies the frame until which there will be linear interpolation, beginning at endTime. Must be used with the\n rpf/replaceCachedFrame or apf/appendFrame flag. Interpolation is achieved by removing frames between endTime and\n interpEndTime from the cache. Removed frames will be renamed as specified by the f/fileName flag.\n \n - interpStartTime : ist (time) [create]\n Specifies the frame from which to begin linear interpolation, ending at startTime. Must be used with the\n rpf/replaceCachedFrame or apf/appendFrame flags. Interpolation is achieved by removing frames between interpStartTime\n and startTime from the cache. These removed frames will will be renamed as specified by the f/fileName flag.\n \n - noBackup : nb (bool) [create]\n Specifies that backup files should not be created for any files that may be over-written during append, replace or\n delete cache frames. Can only be used with the apf/appendFrame, rpf/replaceCachedFrame or dcf/deleteCachedFrame flags.\n \n - outAttr : oa (unicode) [create]\n Specifies the name of the attribute that will be cached to disk.\n \n - outTangent : ot (unicode) [create]\n Specifies the out-tangent type when interpolating frames after the replaced frame(s). Must be used with the\n ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.\n \n - pc2File : pcf (unicode) [create]\n Specifies the full path to the pc2 file. Must be used in conjunction with the pc2 flag.\n \n - pointCount : pc (bool) [query]\n A query flag which returns the number of points stored in the cache file. The channelName flag should be used to specify\n the channel to be queried.\n \n - points : pts (unicode) [create]\n Specifies the name of a geometry whose points will be cached.\n \n - pointsAndNormals : pan (unicode) [create]\n Specifies the name of a geometry whose points and normals will be cached. The normals is per-vertex per-polygon. The\n normals cache cannot be imported back to geometry. This flag can only be used to export cache file. It cannot be used\n with the apf/appendFrame, dcf/deleteCachedFrame and rpf/replaceCachedFrame flags.\n \n - prefix : p (bool) [create]\n Indicates that the specified fileName should be used as a prefix for the cacheName.\n \n - refresh : r (bool) [create]\n When used during cache creation, forces a screen refresh during caching. This causes the cache creation to be slower but\n allows you to see how the simulation is progressing during the cache.\n \n - replaceCachedFrame : rcf (bool) [create]\n Replaces cached data for the times specified by the startTime/endTime flags. If no time is provided, replaces cache file\n for the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Replaced frames will\n not be deleted, but renamed as specified by the f/fileName flag.\n \n - replaceWithoutSimulating : rws (bool) [edit]\n When replacing cached frames, this flag specifies whether the replacement should come from the cached node without\n simulating or from advancing time and letting the simulation run. This flag is valid only when neither the startTime\n nor endTime flags are used or when both the startTime and endTime flags specify the same time value.\n \n - runupFrames : rf (int) [create,query,edit]\n Specifies the number of frames of runup to simulate ahead of the starting frame. The value must be greater than or equal\n to 0. The default is 2.\n \n - sampleMultiplier : spm (int) [create,query,edit]\n Specifies the sample rate when caches are being created as a multiple of simulation Rate. If the value is 1, then a\n sample will be cached everytime the time is advanced. If the value is 2, then every other sample will be cached, and so\n on. The default is 1.\n \n - simulationRate : smr (time) [create,query,edit]\n Specifies the simulation rate when caches are being created. During cache creation, the time will be advanced by the\n simulation rate, until the end time of the cache is reached or surpassed. The value is given in frames. The default\n value is 1 frame.\n \n - singleCache : sch (bool) [create]\n When used in conjunction with the points, pointsAndNormal or cacheableNode flag, specifies whether multiple geometries\n should be put into a single cache or to create one cache per geometry (default).\n \n - startTime : st (time) [create]\n Specifies the start frame of the cache range.\n \n - staticCache : sc (bool) [create,query]\n If false, during cache creation, do not save a cache for the object if it appears to have no animation or deformation.\n If true, save a cache even if the object appears to have no animation or deformation. Default is true. In query mode,\n when supplied a shape, the flag returns true if the shape appears to have no animation or deformation.\n \n - worldSpace : ws (bool) [create]\n If the points flag is used, turning on this flag will result in the world space positions of the points being written.\n The expected use of this flag is for cache export. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cacheFile`\n "
pass
|
def cacheFile(*args, **kwargs):
"\n Creates one or more cache files on disk to store attribute data for a span of frames. The caches can be created for\n points/normals on a geometry (using the pts/points or pan/pointsAndNormals flag), for vectorArray output data (using the\n oa/outAttr flag), or for additional node specific data (using the cnd/cacheableNode flag for those nodes that support\n it). When the ia/inAttr flag is used, connects a cacheFile node that associates the data file on disk with the\n attribute. Frames can be replaced/appended to an existing cache with the rcf/replaceCachedFrame and apf/appendFrame\n flag. Replaced frames are never deleted. They are stored in the same directory as the original cache files with the\n name provided by the f/fileName flag. If no file name is provided, the cacheFile name is prefixed with backupfollowed by\n a unique number. Single file caches are backed up in their entirety. To revert to an older version, simply attach to\n this cache. One file per frame caches only backup the description file and the frames that were replaced. To recover\n these types of caches, the user must rename these files to the original name.\n \n Flags:\n - appendFrame : apf (bool) [create]\n Appends data to the cache for the times specified by the startTime and endTime flags. If no time is provided, appends\n the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Any overwritten frames will\n not be deleted, but renamed as specified by the f/fileName flag.\n \n - attachFile : af (bool) [create]\n Used to indicate that rather than creating a cache file, that an existing cache file on disk should be attached to an\n attribute in the scene. The inAttr flag is used to specify the attribute.\n \n - cacheFileNode : cfn (unicode) [create]\n Specifies the name of the cache file node(s) we are appending/replacing to if more than one cache is attached to the\n specified geometries.\n \n - cacheFormat : cf (unicode) [create,query]\n Cache file format, default is Maya's .mcx format, but others available via plugin\n \n - cacheInfo : ci (unicode) [create,query]\n In create mode, used to specify a mel script returning a string array. When creating the cache, this mel script will be\n executed and the returned strings will be written to the .xml description file of the cache. In query mode, returns\n descriptive info stored in the cacheFile such as the user name, Maya scene name and maya version number.\n \n - cacheableAttrs : cat (unicode) [query]\n Returns the list of cacheable attributes defined on the accompanying cache node. This argument requires the use of the\n cacheableNode flag.\n \n - cacheableNode : cnd (unicode) [create]\n Specifies the name of a cacheable node whose contents will be cached. A cacheable node is a node that is specially\n designed to work with the caching mechanism. An example of a cacheable node is a nCloth node.\n \n - channelIndex : chi (bool) [create,query]\n A query-only flag which returns the channel index for the selected geometry for the cacheFile node specified using the\n cacheFileNode flag.\n \n - channelName : cnm (unicode) [create,query]\n When attachFile is used, used to indicate the channel in the file that should be attached to inAttr. If not specified,\n the first channel in the file is used. In query mode, allows user to query the channels associated with a description\n file.\n \n - convertPc2 : pc2 (bool) [create]\n Convert a PC2 file to the Maya cache format (true), or convert Maya cache to pc2 format (false)\n \n - createCacheNode : ccn (bool) [create]\n Used to indicate that rather than creating a cache file, that a cacheFile node should be created related to an existing\n cache file on disk.\n \n - creationChannelName : cch (unicode) [create]\n When creating a new cache, this multi-use flag specifies the channels to be cached. The names come from the cacheable\n channel names defined by the object being cached. If this flag is not used when creating a cache, then all cacheable\n channels are cached.\n \n - dataSize : dsz (bool) [query]\n This is a query-only flag that returns the size of the data being cached per frame. This flag is to be used in\n conjunction with the cacheableNode, points, pointsAndNormals and outAttr flags.\n \n - deleteCachedFrame : dcf (bool) [create]\n Deletes cached data for the times specified by the startTime/endTime flags. If no time is provided, deletes the current\n frame. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Deleted frames will not be removed\n from disk, but renamed as specified by the f/fileName flag.\n \n - descriptionFileName : dfn (bool) [query]\n This is a query-only flag that returns the name of the description file for an existing cacheFile node. Or if no\n cacheFile node is specified, it returns the description file name that would be created based on the other flags\n specified.\n \n - directory : dir (unicode) [create,query]\n Specifies the directory where the cache files will be located. If the directory flag is not specified, the cache files\n will be placed in the project data directory.\n \n - doubleToFloat : dtf (bool) [create]\n During cache creation, double data is stored in the file as floats. This helps cut down file size.\n \n - endTime : et (time) [create]\n Specifies the end frame of the cache range.\n \n - fileName : f (unicode) [create,query]\n Specifies the base file name for the cache files. If more than one object is being cached and the format is\n OneFilePerFrame, each cache file will be prefixed with this base file name. In query mode, returns the files associated\n with the specified cacheFile node. When used with rpf/replaceCachedFrame or apf/appendFrame specifies the name of the\n backup files. If not specified, replaced frames will be stored with a default name. In query mode, this flag can accept\n a value.\n \n - format : fm (unicode) [create]\n Specifies the distribution format of the cache. Valid values are OneFileand OneFilePerFrame\n \n - geometry : gm (bool) [query]\n A query flag which returns the geometry controlled by the specified cache node\n \n - inAttr : ia (unicode) [create]\n Specifies the name of the attribute that the cache file will drive. This file is optional when creating cache files. If\n this flag is not used during create mode, the cache files will be created on disk, but will not be driving anything in\n the scene. This flag is required when the attachFile flag is used.\n \n - inTangent : it (unicode) [create]\n Specifies the in-tangent type when interpolating frames before the replaced frame(s). Must be used with the\n ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.\n \n - interpEndTime : iet (time) [create]\n Specifies the frame until which there will be linear interpolation, beginning at endTime. Must be used with the\n rpf/replaceCachedFrame or apf/appendFrame flag. Interpolation is achieved by removing frames between endTime and\n interpEndTime from the cache. Removed frames will be renamed as specified by the f/fileName flag.\n \n - interpStartTime : ist (time) [create]\n Specifies the frame from which to begin linear interpolation, ending at startTime. Must be used with the\n rpf/replaceCachedFrame or apf/appendFrame flags. Interpolation is achieved by removing frames between interpStartTime\n and startTime from the cache. These removed frames will will be renamed as specified by the f/fileName flag.\n \n - noBackup : nb (bool) [create]\n Specifies that backup files should not be created for any files that may be over-written during append, replace or\n delete cache frames. Can only be used with the apf/appendFrame, rpf/replaceCachedFrame or dcf/deleteCachedFrame flags.\n \n - outAttr : oa (unicode) [create]\n Specifies the name of the attribute that will be cached to disk.\n \n - outTangent : ot (unicode) [create]\n Specifies the out-tangent type when interpolating frames after the replaced frame(s). Must be used with the\n ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.\n \n - pc2File : pcf (unicode) [create]\n Specifies the full path to the pc2 file. Must be used in conjunction with the pc2 flag.\n \n - pointCount : pc (bool) [query]\n A query flag which returns the number of points stored in the cache file. The channelName flag should be used to specify\n the channel to be queried.\n \n - points : pts (unicode) [create]\n Specifies the name of a geometry whose points will be cached.\n \n - pointsAndNormals : pan (unicode) [create]\n Specifies the name of a geometry whose points and normals will be cached. The normals is per-vertex per-polygon. The\n normals cache cannot be imported back to geometry. This flag can only be used to export cache file. It cannot be used\n with the apf/appendFrame, dcf/deleteCachedFrame and rpf/replaceCachedFrame flags.\n \n - prefix : p (bool) [create]\n Indicates that the specified fileName should be used as a prefix for the cacheName.\n \n - refresh : r (bool) [create]\n When used during cache creation, forces a screen refresh during caching. This causes the cache creation to be slower but\n allows you to see how the simulation is progressing during the cache.\n \n - replaceCachedFrame : rcf (bool) [create]\n Replaces cached data for the times specified by the startTime/endTime flags. If no time is provided, replaces cache file\n for the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Replaced frames will\n not be deleted, but renamed as specified by the f/fileName flag.\n \n - replaceWithoutSimulating : rws (bool) [edit]\n When replacing cached frames, this flag specifies whether the replacement should come from the cached node without\n simulating or from advancing time and letting the simulation run. This flag is valid only when neither the startTime\n nor endTime flags are used or when both the startTime and endTime flags specify the same time value.\n \n - runupFrames : rf (int) [create,query,edit]\n Specifies the number of frames of runup to simulate ahead of the starting frame. The value must be greater than or equal\n to 0. The default is 2.\n \n - sampleMultiplier : spm (int) [create,query,edit]\n Specifies the sample rate when caches are being created as a multiple of simulation Rate. If the value is 1, then a\n sample will be cached everytime the time is advanced. If the value is 2, then every other sample will be cached, and so\n on. The default is 1.\n \n - simulationRate : smr (time) [create,query,edit]\n Specifies the simulation rate when caches are being created. During cache creation, the time will be advanced by the\n simulation rate, until the end time of the cache is reached or surpassed. The value is given in frames. The default\n value is 1 frame.\n \n - singleCache : sch (bool) [create]\n When used in conjunction with the points, pointsAndNormal or cacheableNode flag, specifies whether multiple geometries\n should be put into a single cache or to create one cache per geometry (default).\n \n - startTime : st (time) [create]\n Specifies the start frame of the cache range.\n \n - staticCache : sc (bool) [create,query]\n If false, during cache creation, do not save a cache for the object if it appears to have no animation or deformation.\n If true, save a cache even if the object appears to have no animation or deformation. Default is true. In query mode,\n when supplied a shape, the flag returns true if the shape appears to have no animation or deformation.\n \n - worldSpace : ws (bool) [create]\n If the points flag is used, turning on this flag will result in the world space positions of the points being written.\n The expected use of this flag is for cache export. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cacheFile`\n "
pass<|docstring|>Creates one or more cache files on disk to store attribute data for a span of frames. The caches can be created for
points/normals on a geometry (using the pts/points or pan/pointsAndNormals flag), for vectorArray output data (using the
oa/outAttr flag), or for additional node specific data (using the cnd/cacheableNode flag for those nodes that support
it). When the ia/inAttr flag is used, connects a cacheFile node that associates the data file on disk with the
attribute. Frames can be replaced/appended to an existing cache with the rcf/replaceCachedFrame and apf/appendFrame
flag. Replaced frames are never deleted. They are stored in the same directory as the original cache files with the
name provided by the f/fileName flag. If no file name is provided, the cacheFile name is prefixed with backupfollowed by
a unique number. Single file caches are backed up in their entirety. To revert to an older version, simply attach to
this cache. One file per frame caches only backup the description file and the frames that were replaced. To recover
these types of caches, the user must rename these files to the original name.
Flags:
- appendFrame : apf (bool) [create]
Appends data to the cache for the times specified by the startTime and endTime flags. If no time is provided, appends
the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Any overwritten frames will
not be deleted, but renamed as specified by the f/fileName flag.
- attachFile : af (bool) [create]
Used to indicate that rather than creating a cache file, that an existing cache file on disk should be attached to an
attribute in the scene. The inAttr flag is used to specify the attribute.
- cacheFileNode : cfn (unicode) [create]
Specifies the name of the cache file node(s) we are appending/replacing to if more than one cache is attached to the
specified geometries.
- cacheFormat : cf (unicode) [create,query]
Cache file format, default is Maya's .mcx format, but others available via plugin
- cacheInfo : ci (unicode) [create,query]
In create mode, used to specify a mel script returning a string array. When creating the cache, this mel script will be
executed and the returned strings will be written to the .xml description file of the cache. In query mode, returns
descriptive info stored in the cacheFile such as the user name, Maya scene name and maya version number.
- cacheableAttrs : cat (unicode) [query]
Returns the list of cacheable attributes defined on the accompanying cache node. This argument requires the use of the
cacheableNode flag.
- cacheableNode : cnd (unicode) [create]
Specifies the name of a cacheable node whose contents will be cached. A cacheable node is a node that is specially
designed to work with the caching mechanism. An example of a cacheable node is a nCloth node.
- channelIndex : chi (bool) [create,query]
A query-only flag which returns the channel index for the selected geometry for the cacheFile node specified using the
cacheFileNode flag.
- channelName : cnm (unicode) [create,query]
When attachFile is used, used to indicate the channel in the file that should be attached to inAttr. If not specified,
the first channel in the file is used. In query mode, allows user to query the channels associated with a description
file.
- convertPc2 : pc2 (bool) [create]
Convert a PC2 file to the Maya cache format (true), or convert Maya cache to pc2 format (false)
- createCacheNode : ccn (bool) [create]
Used to indicate that rather than creating a cache file, that a cacheFile node should be created related to an existing
cache file on disk.
- creationChannelName : cch (unicode) [create]
When creating a new cache, this multi-use flag specifies the channels to be cached. The names come from the cacheable
channel names defined by the object being cached. If this flag is not used when creating a cache, then all cacheable
channels are cached.
- dataSize : dsz (bool) [query]
This is a query-only flag that returns the size of the data being cached per frame. This flag is to be used in
conjunction with the cacheableNode, points, pointsAndNormals and outAttr flags.
- deleteCachedFrame : dcf (bool) [create]
Deletes cached data for the times specified by the startTime/endTime flags. If no time is provided, deletes the current
frame. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Deleted frames will not be removed
from disk, but renamed as specified by the f/fileName flag.
- descriptionFileName : dfn (bool) [query]
This is a query-only flag that returns the name of the description file for an existing cacheFile node. Or if no
cacheFile node is specified, it returns the description file name that would be created based on the other flags
specified.
- directory : dir (unicode) [create,query]
Specifies the directory where the cache files will be located. If the directory flag is not specified, the cache files
will be placed in the project data directory.
- doubleToFloat : dtf (bool) [create]
During cache creation, double data is stored in the file as floats. This helps cut down file size.
- endTime : et (time) [create]
Specifies the end frame of the cache range.
- fileName : f (unicode) [create,query]
Specifies the base file name for the cache files. If more than one object is being cached and the format is
OneFilePerFrame, each cache file will be prefixed with this base file name. In query mode, returns the files associated
with the specified cacheFile node. When used with rpf/replaceCachedFrame or apf/appendFrame specifies the name of the
backup files. If not specified, replaced frames will be stored with a default name. In query mode, this flag can accept
a value.
- format : fm (unicode) [create]
Specifies the distribution format of the cache. Valid values are OneFileand OneFilePerFrame
- geometry : gm (bool) [query]
A query flag which returns the geometry controlled by the specified cache node
- inAttr : ia (unicode) [create]
Specifies the name of the attribute that the cache file will drive. This file is optional when creating cache files. If
this flag is not used during create mode, the cache files will be created on disk, but will not be driving anything in
the scene. This flag is required when the attachFile flag is used.
- inTangent : it (unicode) [create]
Specifies the in-tangent type when interpolating frames before the replaced frame(s). Must be used with the
ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.
- interpEndTime : iet (time) [create]
Specifies the frame until which there will be linear interpolation, beginning at endTime. Must be used with the
rpf/replaceCachedFrame or apf/appendFrame flag. Interpolation is achieved by removing frames between endTime and
interpEndTime from the cache. Removed frames will be renamed as specified by the f/fileName flag.
- interpStartTime : ist (time) [create]
Specifies the frame from which to begin linear interpolation, ending at startTime. Must be used with the
rpf/replaceCachedFrame or apf/appendFrame flags. Interpolation is achieved by removing frames between interpStartTime
and startTime from the cache. These removed frames will will be renamed as specified by the f/fileName flag.
- noBackup : nb (bool) [create]
Specifies that backup files should not be created for any files that may be over-written during append, replace or
delete cache frames. Can only be used with the apf/appendFrame, rpf/replaceCachedFrame or dcf/deleteCachedFrame flags.
- outAttr : oa (unicode) [create]
Specifies the name of the attribute that will be cached to disk.
- outTangent : ot (unicode) [create]
Specifies the out-tangent type when interpolating frames after the replaced frame(s). Must be used with the
ist/interpStartTime and iet/interpEndTime flags. Valid values are linear, smoothand step.
- pc2File : pcf (unicode) [create]
Specifies the full path to the pc2 file. Must be used in conjunction with the pc2 flag.
- pointCount : pc (bool) [query]
A query flag which returns the number of points stored in the cache file. The channelName flag should be used to specify
the channel to be queried.
- points : pts (unicode) [create]
Specifies the name of a geometry whose points will be cached.
- pointsAndNormals : pan (unicode) [create]
Specifies the name of a geometry whose points and normals will be cached. The normals is per-vertex per-polygon. The
normals cache cannot be imported back to geometry. This flag can only be used to export cache file. It cannot be used
with the apf/appendFrame, dcf/deleteCachedFrame and rpf/replaceCachedFrame flags.
- prefix : p (bool) [create]
Indicates that the specified fileName should be used as a prefix for the cacheName.
- refresh : r (bool) [create]
When used during cache creation, forces a screen refresh during caching. This causes the cache creation to be slower but
allows you to see how the simulation is progressing during the cache.
- replaceCachedFrame : rcf (bool) [create]
Replaces cached data for the times specified by the startTime/endTime flags. If no time is provided, replaces cache file
for the current time. Must be used in conjunction with the pts/points or cnd/cacheableNode flag. Replaced frames will
not be deleted, but renamed as specified by the f/fileName flag.
- replaceWithoutSimulating : rws (bool) [edit]
When replacing cached frames, this flag specifies whether the replacement should come from the cached node without
simulating or from advancing time and letting the simulation run. This flag is valid only when neither the startTime
nor endTime flags are used or when both the startTime and endTime flags specify the same time value.
- runupFrames : rf (int) [create,query,edit]
Specifies the number of frames of runup to simulate ahead of the starting frame. The value must be greater than or equal
to 0. The default is 2.
- sampleMultiplier : spm (int) [create,query,edit]
Specifies the sample rate when caches are being created as a multiple of simulation Rate. If the value is 1, then a
sample will be cached everytime the time is advanced. If the value is 2, then every other sample will be cached, and so
on. The default is 1.
- simulationRate : smr (time) [create,query,edit]
Specifies the simulation rate when caches are being created. During cache creation, the time will be advanced by the
simulation rate, until the end time of the cache is reached or surpassed. The value is given in frames. The default
value is 1 frame.
- singleCache : sch (bool) [create]
When used in conjunction with the points, pointsAndNormal or cacheableNode flag, specifies whether multiple geometries
should be put into a single cache or to create one cache per geometry (default).
- startTime : st (time) [create]
Specifies the start frame of the cache range.
- staticCache : sc (bool) [create,query]
If false, during cache creation, do not save a cache for the object if it appears to have no animation or deformation.
If true, save a cache even if the object appears to have no animation or deformation. Default is true. In query mode,
when supplied a shape, the flag returns true if the shape appears to have no animation or deformation.
- worldSpace : ws (bool) [create]
If the points flag is used, turning on this flag will result in the world space positions of the points being written.
The expected use of this flag is for cache export. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.cacheFile`<|endoftext|>
|
cbecdcc1f5dcbef2770e990ff3776fed76051515b6e9f3c76fb810e8eb7313b2
|
def saveImage(*args, **kwargs):
"\n This command creates a static image for non-xpm files. Any image file format supported by the file texture node is\n supported by this command. This command creates a static image control for non-xpm files used to display a thumbnail\n image of the scene file.\n \n Flags:\n - annotation : ann (unicode) [create,query,edit]\n Annotate the control with an extra string value.\n \n - backgroundColor : bgc (float, float, float) [create,query,edit]\n The background color of the control. The arguments correspond to the red, green, and blue color components. Each\n component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless\n enableBackground is also specified with a false value.\n \n - currentView : cv (bool) [edit]\n Generate the image from the current view.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt\n render/multiLister/createNode/material\n \n - dragCallback : dgc (script) [create,edit]\n Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:\n global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that\n is transferred to the drop site. By convention the first string in the array describes the user settable message type.\n Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers\n CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,\n but there are two ways to specify the callback. The recommended way is to pass a Python function object as the\n argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The\n values of these arguments are the same as those for the MEL version above. The other way to specify the callback in\n Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the\n standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,\n modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print\n '%(dragControl)s %(x)d %(y)d %(modifiers)d'\n \n - dropCallback : dpc (script) [create,edit]\n Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the\n callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int\n $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs\n array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.\n $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify\n the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python\n callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of\n these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to\n specify a string to be executed. In that case, the string will have the values substituted into it via the standard\n Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,\n x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print\n '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'\n \n - enable : en (bool) [create,query,edit]\n The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and\n the control will appear dimmed or greyed-out indicating it is disabled.\n \n - enableBackground : ebg (bool) [create,query,edit]\n Enables the background color of the control.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - fullPathName : fpn (bool) [query]\n Return the full path name of the widget, which includes all the parents\n \n - height : h (int) [create,query,edit]\n The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.\n \n - highlightColor : hlc (float, float, float) [create,query,edit]\n The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each\n component ranges in value from 0.0 to 1.0.\n \n - image : i (unicode) [create,query,edit]\n Sets the image given the file name.\n \n - isObscured : io (bool) [query]\n Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if\n it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's\n window is invisible or iconified.\n \n - manage : m (bool) [create,query,edit]\n Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All\n controls are created managed by default.\n \n - noBackground : nbg (bool) [create,edit]\n Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the\n background should be drawn. The state of this flag is inherited by children of this control.\n \n - numberOfPopupMenus : npm (bool) [query]\n Return the number of popup menus attached to this control.\n \n - objectThumbnail : ot (unicode) [edit]\n Use an image of the named object, if possible.\n \n - parent : p (unicode) [create,query]\n The parent layout for this control.\n \n - popupMenuArray : pma (bool) [query]\n Return the names of all the popup menus attached to this control.\n \n - preventOverride : po (bool) [create,query,edit]\n If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.\n \n - sceneFile : sf (unicode) [edit]\n The name of the file that the icon is to be associated with.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one.\n \n - visible : vis (bool) [create,query,edit]\n The visible state of the control. A control is created visible by default. Note that a control's actual appearance is\n also dependent on the visible state of its parent layout(s).\n \n - visibleChangeCommand : vcc (script) [create,query,edit]\n Command that gets executed when visible state of the control changes.\n \n - width : w (int) [create,query,edit]\n The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.saveImage`\n "
pass
|
This command creates a static image for non-xpm files. Any image file format supported by the file texture node is
supported by this command. This command creates a static image control for non-xpm files used to display a thumbnail
image of the scene file.
Flags:
- annotation : ann (unicode) [create,query,edit]
Annotate the control with an extra string value.
- backgroundColor : bgc (float, float, float) [create,query,edit]
The background color of the control. The arguments correspond to the red, green, and blue color components. Each
component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless
enableBackground is also specified with a false value.
- currentView : cv (bool) [edit]
Generate the image from the current view.
- defineTemplate : dt (unicode) [create]
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the
argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
as the current template.
- docTag : dtg (unicode) [create,query,edit]
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt
render/multiLister/createNode/material
- dragCallback : dgc (script) [create,edit]
Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:
global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that
is transferred to the drop site. By convention the first string in the array describes the user settable message type.
Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers
CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,
but there are two ways to specify the callback. The recommended way is to pass a Python function object as the
argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The
values of these arguments are the same as those for the MEL version above. The other way to specify the callback in
Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the
standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,
modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
'%(dragControl)s %(x)d %(y)d %(modifiers)d'
- dropCallback : dpc (script) [create,edit]
Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the
callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int
$y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs
array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.
$type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify
the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python
callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of
these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to
specify a string to be executed. In that case, the string will have the values substituted into it via the standard
Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,
x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
'%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'
- enable : en (bool) [create,query,edit]
The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and
the control will appear dimmed or greyed-out indicating it is disabled.
- enableBackground : ebg (bool) [create,query,edit]
Enables the background color of the control.
- exists : ex (bool) [create]
Returns whether the specified object exists or not. Other flags are ignored.
- fullPathName : fpn (bool) [query]
Return the full path name of the widget, which includes all the parents
- height : h (int) [create,query,edit]
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
- highlightColor : hlc (float, float, float) [create,query,edit]
The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each
component ranges in value from 0.0 to 1.0.
- image : i (unicode) [create,query,edit]
Sets the image given the file name.
- isObscured : io (bool) [query]
Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if
it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's
window is invisible or iconified.
- manage : m (bool) [create,query,edit]
Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All
controls are created managed by default.
- noBackground : nbg (bool) [create,edit]
Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the
background should be drawn. The state of this flag is inherited by children of this control.
- numberOfPopupMenus : npm (bool) [query]
Return the number of popup menus attached to this control.
- objectThumbnail : ot (unicode) [edit]
Use an image of the named object, if possible.
- parent : p (unicode) [create,query]
The parent layout for this control.
- popupMenuArray : pma (bool) [query]
Return the names of all the popup menus attached to this control.
- preventOverride : po (bool) [create,query,edit]
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
- sceneFile : sf (unicode) [edit]
The name of the file that the icon is to be associated with.
- useTemplate : ut (unicode) [create]
Forces the command to use a command template other than the current one.
- visible : vis (bool) [create,query,edit]
The visible state of the control. A control is created visible by default. Note that a control's actual appearance is
also dependent on the visible state of its parent layout(s).
- visibleChangeCommand : vcc (script) [create,query,edit]
Command that gets executed when visible state of the control changes.
- width : w (int) [create,query,edit]
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.saveImage`
|
mayaSDK/pymel/core/system.py
|
saveImage
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def saveImage(*args, **kwargs):
"\n This command creates a static image for non-xpm files. Any image file format supported by the file texture node is\n supported by this command. This command creates a static image control for non-xpm files used to display a thumbnail\n image of the scene file.\n \n Flags:\n - annotation : ann (unicode) [create,query,edit]\n Annotate the control with an extra string value.\n \n - backgroundColor : bgc (float, float, float) [create,query,edit]\n The background color of the control. The arguments correspond to the red, green, and blue color components. Each\n component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless\n enableBackground is also specified with a false value.\n \n - currentView : cv (bool) [edit]\n Generate the image from the current view.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt\n render/multiLister/createNode/material\n \n - dragCallback : dgc (script) [create,edit]\n Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:\n global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that\n is transferred to the drop site. By convention the first string in the array describes the user settable message type.\n Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers\n CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,\n but there are two ways to specify the callback. The recommended way is to pass a Python function object as the\n argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The\n values of these arguments are the same as those for the MEL version above. The other way to specify the callback in\n Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the\n standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,\n modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print\n '%(dragControl)s %(x)d %(y)d %(modifiers)d'\n \n - dropCallback : dpc (script) [create,edit]\n Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the\n callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int\n $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs\n array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.\n $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify\n the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python\n callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of\n these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to\n specify a string to be executed. In that case, the string will have the values substituted into it via the standard\n Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,\n x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print\n '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'\n \n - enable : en (bool) [create,query,edit]\n The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and\n the control will appear dimmed or greyed-out indicating it is disabled.\n \n - enableBackground : ebg (bool) [create,query,edit]\n Enables the background color of the control.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - fullPathName : fpn (bool) [query]\n Return the full path name of the widget, which includes all the parents\n \n - height : h (int) [create,query,edit]\n The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.\n \n - highlightColor : hlc (float, float, float) [create,query,edit]\n The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each\n component ranges in value from 0.0 to 1.0.\n \n - image : i (unicode) [create,query,edit]\n Sets the image given the file name.\n \n - isObscured : io (bool) [query]\n Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if\n it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's\n window is invisible or iconified.\n \n - manage : m (bool) [create,query,edit]\n Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All\n controls are created managed by default.\n \n - noBackground : nbg (bool) [create,edit]\n Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the\n background should be drawn. The state of this flag is inherited by children of this control.\n \n - numberOfPopupMenus : npm (bool) [query]\n Return the number of popup menus attached to this control.\n \n - objectThumbnail : ot (unicode) [edit]\n Use an image of the named object, if possible.\n \n - parent : p (unicode) [create,query]\n The parent layout for this control.\n \n - popupMenuArray : pma (bool) [query]\n Return the names of all the popup menus attached to this control.\n \n - preventOverride : po (bool) [create,query,edit]\n If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.\n \n - sceneFile : sf (unicode) [edit]\n The name of the file that the icon is to be associated with.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one.\n \n - visible : vis (bool) [create,query,edit]\n The visible state of the control. A control is created visible by default. Note that a control's actual appearance is\n also dependent on the visible state of its parent layout(s).\n \n - visibleChangeCommand : vcc (script) [create,query,edit]\n Command that gets executed when visible state of the control changes.\n \n - width : w (int) [create,query,edit]\n The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.saveImage`\n "
pass
|
def saveImage(*args, **kwargs):
"\n This command creates a static image for non-xpm files. Any image file format supported by the file texture node is\n supported by this command. This command creates a static image control for non-xpm files used to display a thumbnail\n image of the scene file.\n \n Flags:\n - annotation : ann (unicode) [create,query,edit]\n Annotate the control with an extra string value.\n \n - backgroundColor : bgc (float, float, float) [create,query,edit]\n The background color of the control. The arguments correspond to the red, green, and blue color components. Each\n component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless\n enableBackground is also specified with a false value.\n \n - currentView : cv (bool) [edit]\n Generate the image from the current view.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt\n render/multiLister/createNode/material\n \n - dragCallback : dgc (script) [create,edit]\n Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:\n global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that\n is transferred to the drop site. By convention the first string in the array describes the user settable message type.\n Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers\n CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,\n but there are two ways to specify the callback. The recommended way is to pass a Python function object as the\n argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The\n values of these arguments are the same as those for the MEL version above. The other way to specify the callback in\n Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the\n standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,\n modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print\n '%(dragControl)s %(x)d %(y)d %(modifiers)d'\n \n - dropCallback : dpc (script) [create,edit]\n Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the\n callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int\n $y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs\n array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.\n $type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify\n the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python\n callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of\n these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to\n specify a string to be executed. In that case, the string will have the values substituted into it via the standard\n Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,\n x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print\n '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'\n \n - enable : en (bool) [create,query,edit]\n The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and\n the control will appear dimmed or greyed-out indicating it is disabled.\n \n - enableBackground : ebg (bool) [create,query,edit]\n Enables the background color of the control.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - fullPathName : fpn (bool) [query]\n Return the full path name of the widget, which includes all the parents\n \n - height : h (int) [create,query,edit]\n The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.\n \n - highlightColor : hlc (float, float, float) [create,query,edit]\n The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each\n component ranges in value from 0.0 to 1.0.\n \n - image : i (unicode) [create,query,edit]\n Sets the image given the file name.\n \n - isObscured : io (bool) [query]\n Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if\n it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's\n window is invisible or iconified.\n \n - manage : m (bool) [create,query,edit]\n Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All\n controls are created managed by default.\n \n - noBackground : nbg (bool) [create,edit]\n Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the\n background should be drawn. The state of this flag is inherited by children of this control.\n \n - numberOfPopupMenus : npm (bool) [query]\n Return the number of popup menus attached to this control.\n \n - objectThumbnail : ot (unicode) [edit]\n Use an image of the named object, if possible.\n \n - parent : p (unicode) [create,query]\n The parent layout for this control.\n \n - popupMenuArray : pma (bool) [query]\n Return the names of all the popup menus attached to this control.\n \n - preventOverride : po (bool) [create,query,edit]\n If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.\n \n - sceneFile : sf (unicode) [edit]\n The name of the file that the icon is to be associated with.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one.\n \n - visible : vis (bool) [create,query,edit]\n The visible state of the control. A control is created visible by default. Note that a control's actual appearance is\n also dependent on the visible state of its parent layout(s).\n \n - visibleChangeCommand : vcc (script) [create,query,edit]\n Command that gets executed when visible state of the control changes.\n \n - width : w (int) [create,query,edit]\n The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.saveImage`\n "
pass<|docstring|>This command creates a static image for non-xpm files. Any image file format supported by the file texture node is
supported by this command. This command creates a static image control for non-xpm files used to display a thumbnail
image of the scene file.
Flags:
- annotation : ann (unicode) [create,query,edit]
Annotate the control with an extra string value.
- backgroundColor : bgc (float, float, float) [create,query,edit]
The background color of the control. The arguments correspond to the red, green, and blue color components. Each
component ranges in value from 0.0 to 1.0. When setting backgroundColor, the background is automatically enabled, unless
enableBackground is also specified with a false value.
- currentView : cv (bool) [edit]
Generate the image from the current view.
- defineTemplate : dt (unicode) [create]
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the
argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
as the current template.
- docTag : dtg (unicode) [create,query,edit]
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt
render/multiLister/createNode/material
- dragCallback : dgc (script) [create,edit]
Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:
global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods) The proc returns a string array that
is transferred to the drop site. By convention the first string in the array describes the user settable message type.
Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers
CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT. In Python, it is similar,
but there are two ways to specify the callback. The recommended way is to pass a Python function object as the
argument. In that case, the Python callback should have the form: def callbackName( dragControl, x, y, modifiers ): The
values of these arguments are the same as those for the MEL version above. The other way to specify the callback in
Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the
standard Python format operator. The format values are passed in a dictionary with the keys dragControl, x, y,
modifiers. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
'%(dragControl)s %(x)d %(y)d %(modifiers)d'
- dropCallback : dpc (script) [create,edit]
Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the
callback is of the form: global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int
$y, int $type) The proc receives a string array that is transferred from the drag source. The first string in the msgs
array describes the user defined message type. Controls that are application defined drop sites may ignore the callback.
$type can have values of 1 == Move, 2 == Copy, 3 == Link. In Python, it is similar, but there are two ways to specify
the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python
callback should have the form: def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ): The values of
these arguments are the same as those for the MEL version above. The other way to specify the callback in Python is to
specify a string to be executed. In that case, the string will have the values substituted into it via the standard
Python format operator. The format values are passed in a dictionary with the keys dragControl, dropControl, messages,
x, y, type. The dragControlvalue is a string and the other values are integers (eg the callback string could be print
'%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'
- enable : en (bool) [create,query,edit]
The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and
the control will appear dimmed or greyed-out indicating it is disabled.
- enableBackground : ebg (bool) [create,query,edit]
Enables the background color of the control.
- exists : ex (bool) [create]
Returns whether the specified object exists or not. Other flags are ignored.
- fullPathName : fpn (bool) [query]
Return the full path name of the widget, which includes all the parents
- height : h (int) [create,query,edit]
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
- highlightColor : hlc (float, float, float) [create,query,edit]
The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each
component ranges in value from 0.0 to 1.0.
- image : i (unicode) [create,query,edit]
Sets the image given the file name.
- isObscured : io (bool) [query]
Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if
it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's
window is invisible or iconified.
- manage : m (bool) [create,query,edit]
Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All
controls are created managed by default.
- noBackground : nbg (bool) [create,edit]
Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the
background should be drawn. The state of this flag is inherited by children of this control.
- numberOfPopupMenus : npm (bool) [query]
Return the number of popup menus attached to this control.
- objectThumbnail : ot (unicode) [edit]
Use an image of the named object, if possible.
- parent : p (unicode) [create,query]
The parent layout for this control.
- popupMenuArray : pma (bool) [query]
Return the names of all the popup menus attached to this control.
- preventOverride : po (bool) [create,query,edit]
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
- sceneFile : sf (unicode) [edit]
The name of the file that the icon is to be associated with.
- useTemplate : ut (unicode) [create]
Forces the command to use a command template other than the current one.
- visible : vis (bool) [create,query,edit]
The visible state of the control. A control is created visible by default. Note that a control's actual appearance is
also dependent on the visible state of its parent layout(s).
- visibleChangeCommand : vcc (script) [create,query,edit]
Command that gets executed when visible state of the control changes.
- width : w (int) [create,query,edit]
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.saveImage`<|endoftext|>
|
f3ca3bd05c7838bbbfd06a7cb7fc06d482540ea48e79da1fba4e2e49d25fc2cd
|
def flushUndo(*args, **kwargs):
'\n Removes everything from the undo queue, freeing up memory.\n \n \n Derived from mel command `maya.cmds.flushUndo`\n '
pass
|
Removes everything from the undo queue, freeing up memory.
Derived from mel command `maya.cmds.flushUndo`
|
mayaSDK/pymel/core/system.py
|
flushUndo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def flushUndo(*args, **kwargs):
'\n Removes everything from the undo queue, freeing up memory.\n \n \n Derived from mel command `maya.cmds.flushUndo`\n '
pass
|
def flushUndo(*args, **kwargs):
'\n Removes everything from the undo queue, freeing up memory.\n \n \n Derived from mel command `maya.cmds.flushUndo`\n '
pass<|docstring|>Removes everything from the undo queue, freeing up memory.
Derived from mel command `maya.cmds.flushUndo`<|endoftext|>
|
a8b6c6ac154f65ebc34dba3656f1ac2e8a6c1fe97f0d4160666ffe1c2f662871
|
def dgInfo(*args, **kwargs):
"\n This command prints information about the DG in plain text. The scope of the information printed is the entire graph if\n the allflag is used, the nodes/plugs on the command line if they were specified, and the selection list, in that order.\n Each plug on a connection will have two pieces of state information displayed together at the end of the line on which\n they are printed. There are two possible values for each of the two states displayed. The values are updated when the DG\n pulls data across them, usually through evaluation, or pushes a dirty message through them. There are some subtleties in\n how the data is pulled through the connection but for simplicity it will be referred to as evaluation. The values\n displayed will be CLEAN or DIRTY followed by PROP or BLOCK. The first keyword has these meanings: CLEANmeans that\n evaluation of the plug's connection succeeded and no dirty messages have come through it since then. It also implies\n that the destination end of the connection has received the value from the source end. DIRTYmeans that a dirty message\n has passed through the plug's connection since the last time an evaluation was made on the destination side of that\n connection. Note: the data on the node has its own dirty state that depends on other factors so having a clean\n connection doesn't necessarily mean the plug's data is clean, and vice versa. The second keyword has these meanings:\n PROPmeans that the connection will allow dirty messages to pass through and forwards them to all destinations.\n BLOCKmeans that a dirty message will stop at this connection and not continue on to any destinations. This is an\n optimization that prevents excessive dirty flag propagation when many values are changing, for example, a frame change\n in an animated sequece. The combination CLEAN BLOCKshould never be seen in a valid DG. This indicates that while the\n plug connection has been evaluated since the last dirty message it will not propagate any new dirty messages coming in\n to it. That in turn means downstream nodes will not be notified that the graph is changing and they will not evaluate\n properly. Recovering from this invalid state requires entering the command dgdirty -ato mark everything dirty and\n restart proper evaluation. Think of this command as the reset/reboot of the DG world. Both state types behave\n differently depending on your connection type. SimpleA -B: Plugs at both ends of the connection share the same state\n information. The state information updates when an evaluation request comes to A from B, or a dirty message is sent from\n A to B. Fan-OutA -B, A -C: Each of A, B, and C have their own unique state information. B and C behave as described\n above. A has its state information linked to B and C - it will have CLEANonly when both B and C have CLEAN, it will have\n BLOCKonly when both B and C have BLOCK. In-OutA -B, C -A: Each of A, B, and C have their own unique state information. B\n and C behave as described above. A has its state information linked to B and C. The CLEAN|DIRTYflag looks backwards,\n then forwards: if( C == CLEAN ) A = CLEAN else if( B == CLEAN ) A = CLEAN The BLOCKstate is set when a dirty message\n passes through A, and the PROPstate is set either when A is set clean or an evaluation passes through A. There are some\n other exceptions to these rules: All of this state change information only applies to dirty messages and evaluations\n that use the normal context. Any changes in other contexts, for example, through the getAttr -t TIMEcommand, does not\n affect the state in the connections. Param curves and other passive inputs, for example blend nodes coming from param\n curves, will not disable propagation. Doing so would make the keyframing workflow impossible. Certain messages can\n choose to completely ignore the connection state information. For example when a node's state attribute changes a\n connection may change to a blocking one so the message has to be propagated at least one step further to all of its\n destinations. This way they can update their information. Certain operations can globally disable the use of the\n propagaton state to reduce message flow. The simplest example is when the evaluation manager is building its graph. It\n has to visit all nodes so the propagation cannot be blocked. The messaging system has safeguards against cyclic messages\n flowing through connections but sometimes a message bypasses the connection completely and goes directly to the node.\n DAG parents do this to send messages to their children. So despite connections into a node all having the BLOCKstate it\n could still receive dirty messages.\n \n Flags:\n - allNodes : all (bool) [create]\n Use the entire graph as the context\n \n - connections : c (bool) [create]\n Print the connection information\n \n - dirty : d (bool) [create]\n Only print dirty/clean nodes/plugs/connections. Default is both\n \n - nodes : n (bool) [create]\n Print the specified nodes (or the entire graph if -all is used)\n \n - nonDeletable : nd (bool) [create]\n Include non-deletable nodes as well (normally not of interest)\n \n - outputFile : of (unicode) [create]\n Send the output to the file FILE instead of STDERR\n \n - propagation : p (bool) [create]\n Only print propagating/not propagating nodes/plugs/connections. Default is both.\n \n - short : s (bool) [create]\n Print using short format instead of long\n \n - size : sz (bool) [create]\n Show datablock sizes for all specified nodes. Return value is tuple of all selected nodes (NumberOfNodes,\n NumberOfDatablocks, TotalDatablockMemory)\n \n - subgraph : sub (bool) [create]\n Print the subgraph affected by the node or plugs (or all nodes in the graph grouped in subgraphs if -all is used)\n \n - type : nt (unicode) [create]\n Filter output to only show nodes of type NODETYPE Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgInfo`\n "
pass
|
This command prints information about the DG in plain text. The scope of the information printed is the entire graph if
the allflag is used, the nodes/plugs on the command line if they were specified, and the selection list, in that order.
Each plug on a connection will have two pieces of state information displayed together at the end of the line on which
they are printed. There are two possible values for each of the two states displayed. The values are updated when the DG
pulls data across them, usually through evaluation, or pushes a dirty message through them. There are some subtleties in
how the data is pulled through the connection but for simplicity it will be referred to as evaluation. The values
displayed will be CLEAN or DIRTY followed by PROP or BLOCK. The first keyword has these meanings: CLEANmeans that
evaluation of the plug's connection succeeded and no dirty messages have come through it since then. It also implies
that the destination end of the connection has received the value from the source end. DIRTYmeans that a dirty message
has passed through the plug's connection since the last time an evaluation was made on the destination side of that
connection. Note: the data on the node has its own dirty state that depends on other factors so having a clean
connection doesn't necessarily mean the plug's data is clean, and vice versa. The second keyword has these meanings:
PROPmeans that the connection will allow dirty messages to pass through and forwards them to all destinations.
BLOCKmeans that a dirty message will stop at this connection and not continue on to any destinations. This is an
optimization that prevents excessive dirty flag propagation when many values are changing, for example, a frame change
in an animated sequece. The combination CLEAN BLOCKshould never be seen in a valid DG. This indicates that while the
plug connection has been evaluated since the last dirty message it will not propagate any new dirty messages coming in
to it. That in turn means downstream nodes will not be notified that the graph is changing and they will not evaluate
properly. Recovering from this invalid state requires entering the command dgdirty -ato mark everything dirty and
restart proper evaluation. Think of this command as the reset/reboot of the DG world. Both state types behave
differently depending on your connection type. SimpleA -B: Plugs at both ends of the connection share the same state
information. The state information updates when an evaluation request comes to A from B, or a dirty message is sent from
A to B. Fan-OutA -B, A -C: Each of A, B, and C have their own unique state information. B and C behave as described
above. A has its state information linked to B and C - it will have CLEANonly when both B and C have CLEAN, it will have
BLOCKonly when both B and C have BLOCK. In-OutA -B, C -A: Each of A, B, and C have their own unique state information. B
and C behave as described above. A has its state information linked to B and C. The CLEAN|DIRTYflag looks backwards,
then forwards: if( C == CLEAN ) A = CLEAN else if( B == CLEAN ) A = CLEAN The BLOCKstate is set when a dirty message
passes through A, and the PROPstate is set either when A is set clean or an evaluation passes through A. There are some
other exceptions to these rules: All of this state change information only applies to dirty messages and evaluations
that use the normal context. Any changes in other contexts, for example, through the getAttr -t TIMEcommand, does not
affect the state in the connections. Param curves and other passive inputs, for example blend nodes coming from param
curves, will not disable propagation. Doing so would make the keyframing workflow impossible. Certain messages can
choose to completely ignore the connection state information. For example when a node's state attribute changes a
connection may change to a blocking one so the message has to be propagated at least one step further to all of its
destinations. This way they can update their information. Certain operations can globally disable the use of the
propagaton state to reduce message flow. The simplest example is when the evaluation manager is building its graph. It
has to visit all nodes so the propagation cannot be blocked. The messaging system has safeguards against cyclic messages
flowing through connections but sometimes a message bypasses the connection completely and goes directly to the node.
DAG parents do this to send messages to their children. So despite connections into a node all having the BLOCKstate it
could still receive dirty messages.
Flags:
- allNodes : all (bool) [create]
Use the entire graph as the context
- connections : c (bool) [create]
Print the connection information
- dirty : d (bool) [create]
Only print dirty/clean nodes/plugs/connections. Default is both
- nodes : n (bool) [create]
Print the specified nodes (or the entire graph if -all is used)
- nonDeletable : nd (bool) [create]
Include non-deletable nodes as well (normally not of interest)
- outputFile : of (unicode) [create]
Send the output to the file FILE instead of STDERR
- propagation : p (bool) [create]
Only print propagating/not propagating nodes/plugs/connections. Default is both.
- short : s (bool) [create]
Print using short format instead of long
- size : sz (bool) [create]
Show datablock sizes for all specified nodes. Return value is tuple of all selected nodes (NumberOfNodes,
NumberOfDatablocks, TotalDatablockMemory)
- subgraph : sub (bool) [create]
Print the subgraph affected by the node or plugs (or all nodes in the graph grouped in subgraphs if -all is used)
- type : nt (unicode) [create]
Filter output to only show nodes of type NODETYPE Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.dgInfo`
|
mayaSDK/pymel/core/system.py
|
dgInfo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def dgInfo(*args, **kwargs):
"\n This command prints information about the DG in plain text. The scope of the information printed is the entire graph if\n the allflag is used, the nodes/plugs on the command line if they were specified, and the selection list, in that order.\n Each plug on a connection will have two pieces of state information displayed together at the end of the line on which\n they are printed. There are two possible values for each of the two states displayed. The values are updated when the DG\n pulls data across them, usually through evaluation, or pushes a dirty message through them. There are some subtleties in\n how the data is pulled through the connection but for simplicity it will be referred to as evaluation. The values\n displayed will be CLEAN or DIRTY followed by PROP or BLOCK. The first keyword has these meanings: CLEANmeans that\n evaluation of the plug's connection succeeded and no dirty messages have come through it since then. It also implies\n that the destination end of the connection has received the value from the source end. DIRTYmeans that a dirty message\n has passed through the plug's connection since the last time an evaluation was made on the destination side of that\n connection. Note: the data on the node has its own dirty state that depends on other factors so having a clean\n connection doesn't necessarily mean the plug's data is clean, and vice versa. The second keyword has these meanings:\n PROPmeans that the connection will allow dirty messages to pass through and forwards them to all destinations.\n BLOCKmeans that a dirty message will stop at this connection and not continue on to any destinations. This is an\n optimization that prevents excessive dirty flag propagation when many values are changing, for example, a frame change\n in an animated sequece. The combination CLEAN BLOCKshould never be seen in a valid DG. This indicates that while the\n plug connection has been evaluated since the last dirty message it will not propagate any new dirty messages coming in\n to it. That in turn means downstream nodes will not be notified that the graph is changing and they will not evaluate\n properly. Recovering from this invalid state requires entering the command dgdirty -ato mark everything dirty and\n restart proper evaluation. Think of this command as the reset/reboot of the DG world. Both state types behave\n differently depending on your connection type. SimpleA -B: Plugs at both ends of the connection share the same state\n information. The state information updates when an evaluation request comes to A from B, or a dirty message is sent from\n A to B. Fan-OutA -B, A -C: Each of A, B, and C have their own unique state information. B and C behave as described\n above. A has its state information linked to B and C - it will have CLEANonly when both B and C have CLEAN, it will have\n BLOCKonly when both B and C have BLOCK. In-OutA -B, C -A: Each of A, B, and C have their own unique state information. B\n and C behave as described above. A has its state information linked to B and C. The CLEAN|DIRTYflag looks backwards,\n then forwards: if( C == CLEAN ) A = CLEAN else if( B == CLEAN ) A = CLEAN The BLOCKstate is set when a dirty message\n passes through A, and the PROPstate is set either when A is set clean or an evaluation passes through A. There are some\n other exceptions to these rules: All of this state change information only applies to dirty messages and evaluations\n that use the normal context. Any changes in other contexts, for example, through the getAttr -t TIMEcommand, does not\n affect the state in the connections. Param curves and other passive inputs, for example blend nodes coming from param\n curves, will not disable propagation. Doing so would make the keyframing workflow impossible. Certain messages can\n choose to completely ignore the connection state information. For example when a node's state attribute changes a\n connection may change to a blocking one so the message has to be propagated at least one step further to all of its\n destinations. This way they can update their information. Certain operations can globally disable the use of the\n propagaton state to reduce message flow. The simplest example is when the evaluation manager is building its graph. It\n has to visit all nodes so the propagation cannot be blocked. The messaging system has safeguards against cyclic messages\n flowing through connections but sometimes a message bypasses the connection completely and goes directly to the node.\n DAG parents do this to send messages to their children. So despite connections into a node all having the BLOCKstate it\n could still receive dirty messages.\n \n Flags:\n - allNodes : all (bool) [create]\n Use the entire graph as the context\n \n - connections : c (bool) [create]\n Print the connection information\n \n - dirty : d (bool) [create]\n Only print dirty/clean nodes/plugs/connections. Default is both\n \n - nodes : n (bool) [create]\n Print the specified nodes (or the entire graph if -all is used)\n \n - nonDeletable : nd (bool) [create]\n Include non-deletable nodes as well (normally not of interest)\n \n - outputFile : of (unicode) [create]\n Send the output to the file FILE instead of STDERR\n \n - propagation : p (bool) [create]\n Only print propagating/not propagating nodes/plugs/connections. Default is both.\n \n - short : s (bool) [create]\n Print using short format instead of long\n \n - size : sz (bool) [create]\n Show datablock sizes for all specified nodes. Return value is tuple of all selected nodes (NumberOfNodes,\n NumberOfDatablocks, TotalDatablockMemory)\n \n - subgraph : sub (bool) [create]\n Print the subgraph affected by the node or plugs (or all nodes in the graph grouped in subgraphs if -all is used)\n \n - type : nt (unicode) [create]\n Filter output to only show nodes of type NODETYPE Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgInfo`\n "
pass
|
def dgInfo(*args, **kwargs):
"\n This command prints information about the DG in plain text. The scope of the information printed is the entire graph if\n the allflag is used, the nodes/plugs on the command line if they were specified, and the selection list, in that order.\n Each plug on a connection will have two pieces of state information displayed together at the end of the line on which\n they are printed. There are two possible values for each of the two states displayed. The values are updated when the DG\n pulls data across them, usually through evaluation, or pushes a dirty message through them. There are some subtleties in\n how the data is pulled through the connection but for simplicity it will be referred to as evaluation. The values\n displayed will be CLEAN or DIRTY followed by PROP or BLOCK. The first keyword has these meanings: CLEANmeans that\n evaluation of the plug's connection succeeded and no dirty messages have come through it since then. It also implies\n that the destination end of the connection has received the value from the source end. DIRTYmeans that a dirty message\n has passed through the plug's connection since the last time an evaluation was made on the destination side of that\n connection. Note: the data on the node has its own dirty state that depends on other factors so having a clean\n connection doesn't necessarily mean the plug's data is clean, and vice versa. The second keyword has these meanings:\n PROPmeans that the connection will allow dirty messages to pass through and forwards them to all destinations.\n BLOCKmeans that a dirty message will stop at this connection and not continue on to any destinations. This is an\n optimization that prevents excessive dirty flag propagation when many values are changing, for example, a frame change\n in an animated sequece. The combination CLEAN BLOCKshould never be seen in a valid DG. This indicates that while the\n plug connection has been evaluated since the last dirty message it will not propagate any new dirty messages coming in\n to it. That in turn means downstream nodes will not be notified that the graph is changing and they will not evaluate\n properly. Recovering from this invalid state requires entering the command dgdirty -ato mark everything dirty and\n restart proper evaluation. Think of this command as the reset/reboot of the DG world. Both state types behave\n differently depending on your connection type. SimpleA -B: Plugs at both ends of the connection share the same state\n information. The state information updates when an evaluation request comes to A from B, or a dirty message is sent from\n A to B. Fan-OutA -B, A -C: Each of A, B, and C have their own unique state information. B and C behave as described\n above. A has its state information linked to B and C - it will have CLEANonly when both B and C have CLEAN, it will have\n BLOCKonly when both B and C have BLOCK. In-OutA -B, C -A: Each of A, B, and C have their own unique state information. B\n and C behave as described above. A has its state information linked to B and C. The CLEAN|DIRTYflag looks backwards,\n then forwards: if( C == CLEAN ) A = CLEAN else if( B == CLEAN ) A = CLEAN The BLOCKstate is set when a dirty message\n passes through A, and the PROPstate is set either when A is set clean or an evaluation passes through A. There are some\n other exceptions to these rules: All of this state change information only applies to dirty messages and evaluations\n that use the normal context. Any changes in other contexts, for example, through the getAttr -t TIMEcommand, does not\n affect the state in the connections. Param curves and other passive inputs, for example blend nodes coming from param\n curves, will not disable propagation. Doing so would make the keyframing workflow impossible. Certain messages can\n choose to completely ignore the connection state information. For example when a node's state attribute changes a\n connection may change to a blocking one so the message has to be propagated at least one step further to all of its\n destinations. This way they can update their information. Certain operations can globally disable the use of the\n propagaton state to reduce message flow. The simplest example is when the evaluation manager is building its graph. It\n has to visit all nodes so the propagation cannot be blocked. The messaging system has safeguards against cyclic messages\n flowing through connections but sometimes a message bypasses the connection completely and goes directly to the node.\n DAG parents do this to send messages to their children. So despite connections into a node all having the BLOCKstate it\n could still receive dirty messages.\n \n Flags:\n - allNodes : all (bool) [create]\n Use the entire graph as the context\n \n - connections : c (bool) [create]\n Print the connection information\n \n - dirty : d (bool) [create]\n Only print dirty/clean nodes/plugs/connections. Default is both\n \n - nodes : n (bool) [create]\n Print the specified nodes (or the entire graph if -all is used)\n \n - nonDeletable : nd (bool) [create]\n Include non-deletable nodes as well (normally not of interest)\n \n - outputFile : of (unicode) [create]\n Send the output to the file FILE instead of STDERR\n \n - propagation : p (bool) [create]\n Only print propagating/not propagating nodes/plugs/connections. Default is both.\n \n - short : s (bool) [create]\n Print using short format instead of long\n \n - size : sz (bool) [create]\n Show datablock sizes for all specified nodes. Return value is tuple of all selected nodes (NumberOfNodes,\n NumberOfDatablocks, TotalDatablockMemory)\n \n - subgraph : sub (bool) [create]\n Print the subgraph affected by the node or plugs (or all nodes in the graph grouped in subgraphs if -all is used)\n \n - type : nt (unicode) [create]\n Filter output to only show nodes of type NODETYPE Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgInfo`\n "
pass<|docstring|>This command prints information about the DG in plain text. The scope of the information printed is the entire graph if
the allflag is used, the nodes/plugs on the command line if they were specified, and the selection list, in that order.
Each plug on a connection will have two pieces of state information displayed together at the end of the line on which
they are printed. There are two possible values for each of the two states displayed. The values are updated when the DG
pulls data across them, usually through evaluation, or pushes a dirty message through them. There are some subtleties in
how the data is pulled through the connection but for simplicity it will be referred to as evaluation. The values
displayed will be CLEAN or DIRTY followed by PROP or BLOCK. The first keyword has these meanings: CLEANmeans that
evaluation of the plug's connection succeeded and no dirty messages have come through it since then. It also implies
that the destination end of the connection has received the value from the source end. DIRTYmeans that a dirty message
has passed through the plug's connection since the last time an evaluation was made on the destination side of that
connection. Note: the data on the node has its own dirty state that depends on other factors so having a clean
connection doesn't necessarily mean the plug's data is clean, and vice versa. The second keyword has these meanings:
PROPmeans that the connection will allow dirty messages to pass through and forwards them to all destinations.
BLOCKmeans that a dirty message will stop at this connection and not continue on to any destinations. This is an
optimization that prevents excessive dirty flag propagation when many values are changing, for example, a frame change
in an animated sequece. The combination CLEAN BLOCKshould never be seen in a valid DG. This indicates that while the
plug connection has been evaluated since the last dirty message it will not propagate any new dirty messages coming in
to it. That in turn means downstream nodes will not be notified that the graph is changing and they will not evaluate
properly. Recovering from this invalid state requires entering the command dgdirty -ato mark everything dirty and
restart proper evaluation. Think of this command as the reset/reboot of the DG world. Both state types behave
differently depending on your connection type. SimpleA -B: Plugs at both ends of the connection share the same state
information. The state information updates when an evaluation request comes to A from B, or a dirty message is sent from
A to B. Fan-OutA -B, A -C: Each of A, B, and C have their own unique state information. B and C behave as described
above. A has its state information linked to B and C - it will have CLEANonly when both B and C have CLEAN, it will have
BLOCKonly when both B and C have BLOCK. In-OutA -B, C -A: Each of A, B, and C have their own unique state information. B
and C behave as described above. A has its state information linked to B and C. The CLEAN|DIRTYflag looks backwards,
then forwards: if( C == CLEAN ) A = CLEAN else if( B == CLEAN ) A = CLEAN The BLOCKstate is set when a dirty message
passes through A, and the PROPstate is set either when A is set clean or an evaluation passes through A. There are some
other exceptions to these rules: All of this state change information only applies to dirty messages and evaluations
that use the normal context. Any changes in other contexts, for example, through the getAttr -t TIMEcommand, does not
affect the state in the connections. Param curves and other passive inputs, for example blend nodes coming from param
curves, will not disable propagation. Doing so would make the keyframing workflow impossible. Certain messages can
choose to completely ignore the connection state information. For example when a node's state attribute changes a
connection may change to a blocking one so the message has to be propagated at least one step further to all of its
destinations. This way they can update their information. Certain operations can globally disable the use of the
propagaton state to reduce message flow. The simplest example is when the evaluation manager is building its graph. It
has to visit all nodes so the propagation cannot be blocked. The messaging system has safeguards against cyclic messages
flowing through connections but sometimes a message bypasses the connection completely and goes directly to the node.
DAG parents do this to send messages to their children. So despite connections into a node all having the BLOCKstate it
could still receive dirty messages.
Flags:
- allNodes : all (bool) [create]
Use the entire graph as the context
- connections : c (bool) [create]
Print the connection information
- dirty : d (bool) [create]
Only print dirty/clean nodes/plugs/connections. Default is both
- nodes : n (bool) [create]
Print the specified nodes (or the entire graph if -all is used)
- nonDeletable : nd (bool) [create]
Include non-deletable nodes as well (normally not of interest)
- outputFile : of (unicode) [create]
Send the output to the file FILE instead of STDERR
- propagation : p (bool) [create]
Only print propagating/not propagating nodes/plugs/connections. Default is both.
- short : s (bool) [create]
Print using short format instead of long
- size : sz (bool) [create]
Show datablock sizes for all specified nodes. Return value is tuple of all selected nodes (NumberOfNodes,
NumberOfDatablocks, TotalDatablockMemory)
- subgraph : sub (bool) [create]
Print the subgraph affected by the node or plugs (or all nodes in the graph grouped in subgraphs if -all is used)
- type : nt (unicode) [create]
Filter output to only show nodes of type NODETYPE Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.dgInfo`<|endoftext|>
|
debc5500d061d8600d947189819820590fb16d9babc68162bb70050efc916ddd
|
def diskCache(*args, **kwargs):
'\n Command to create, clear, or close disk cache(s). In query mode, return type is based on queried flag.\n \n Flags:\n - append : a (bool) [create,query]\n Append at the end and not to flush the existing cache\n \n - cacheType : ct (unicode) [create,query]\n Specifies the type of cache to overwrite. mcfpfor particle playback cache, mcfifor particle initial cache. mcjfor\n jiggle cache. This option is only activated during the cache creation.\n \n - close : c (unicode) [create,query]\n Close the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are\n affected.\n \n - closeAll : ca (bool) [create,query]\n Close all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - delete : d (unicode) [create,query]\n Delete the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are\n affected.\n \n - deleteAll : da (bool) [create,query]\n Delete all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - empty : e (unicode) [create,query]\n Clear the content of the disk cache with the given disk cache node name. If -eco/enabledCachesOnly is trueonly enabled\n disk cache nodes are affected.\n \n - emptyAll : ea (bool) [create,query]\n Clear the content of all disk caches. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - enabledCachesOnly : eco (bool) [create,query]\n When present, this flag restricts the -ea/emptyAll, so that only enableddisk caches (i.e., disk cache nodes with the\n .enableattribute set to true) are affected.\n \n - endTime : et (time) [create,query]\n Specifies the end frame of the cache range.\n \n - frameRangeType : frt (unicode) [create,query]\n Specifies the type of frame range to use, namely Render Globals, Time Slider, and Start/End. In the case of Time\n Slider, startFrame and endFrame need to be specified. (This flag is now obsolete. Please use the -startTime and\n -endTime flags to specify the frame range explicitly.)\n \n - overSample : os (bool) [create,query]\n Over sample if true. Otherwise, under sample.\n \n - samplingRate : sr (int) [create,query]\n Specifies how frequently to sample relative to each frame. When over-sampling (-overSample has been specified), this\n parameter determines how many times per frame the runup will be evaluated. When under-sampling (the default, when\n -overSample has not been specified), the runup will evaluate only once per srframes, where sris the value specified to\n this flag.\n \n - startTime : st (time) [create,query]\n Specifies the start frame of the cache range.\n \n - tempDir : tmp (bool) [create,query]\n Query-only flag for the location of temporary diskCache files. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.diskCache`\n '
pass
|
Command to create, clear, or close disk cache(s). In query mode, return type is based on queried flag.
Flags:
- append : a (bool) [create,query]
Append at the end and not to flush the existing cache
- cacheType : ct (unicode) [create,query]
Specifies the type of cache to overwrite. mcfpfor particle playback cache, mcfifor particle initial cache. mcjfor
jiggle cache. This option is only activated during the cache creation.
- close : c (unicode) [create,query]
Close the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are
affected.
- closeAll : ca (bool) [create,query]
Close all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.
- delete : d (unicode) [create,query]
Delete the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are
affected.
- deleteAll : da (bool) [create,query]
Delete all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.
- empty : e (unicode) [create,query]
Clear the content of the disk cache with the given disk cache node name. If -eco/enabledCachesOnly is trueonly enabled
disk cache nodes are affected.
- emptyAll : ea (bool) [create,query]
Clear the content of all disk caches. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.
- enabledCachesOnly : eco (bool) [create,query]
When present, this flag restricts the -ea/emptyAll, so that only enableddisk caches (i.e., disk cache nodes with the
.enableattribute set to true) are affected.
- endTime : et (time) [create,query]
Specifies the end frame of the cache range.
- frameRangeType : frt (unicode) [create,query]
Specifies the type of frame range to use, namely Render Globals, Time Slider, and Start/End. In the case of Time
Slider, startFrame and endFrame need to be specified. (This flag is now obsolete. Please use the -startTime and
-endTime flags to specify the frame range explicitly.)
- overSample : os (bool) [create,query]
Over sample if true. Otherwise, under sample.
- samplingRate : sr (int) [create,query]
Specifies how frequently to sample relative to each frame. When over-sampling (-overSample has been specified), this
parameter determines how many times per frame the runup will be evaluated. When under-sampling (the default, when
-overSample has not been specified), the runup will evaluate only once per srframes, where sris the value specified to
this flag.
- startTime : st (time) [create,query]
Specifies the start frame of the cache range.
- tempDir : tmp (bool) [create,query]
Query-only flag for the location of temporary diskCache files. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.diskCache`
|
mayaSDK/pymel/core/system.py
|
diskCache
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def diskCache(*args, **kwargs):
'\n Command to create, clear, or close disk cache(s). In query mode, return type is based on queried flag.\n \n Flags:\n - append : a (bool) [create,query]\n Append at the end and not to flush the existing cache\n \n - cacheType : ct (unicode) [create,query]\n Specifies the type of cache to overwrite. mcfpfor particle playback cache, mcfifor particle initial cache. mcjfor\n jiggle cache. This option is only activated during the cache creation.\n \n - close : c (unicode) [create,query]\n Close the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are\n affected.\n \n - closeAll : ca (bool) [create,query]\n Close all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - delete : d (unicode) [create,query]\n Delete the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are\n affected.\n \n - deleteAll : da (bool) [create,query]\n Delete all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - empty : e (unicode) [create,query]\n Clear the content of the disk cache with the given disk cache node name. If -eco/enabledCachesOnly is trueonly enabled\n disk cache nodes are affected.\n \n - emptyAll : ea (bool) [create,query]\n Clear the content of all disk caches. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - enabledCachesOnly : eco (bool) [create,query]\n When present, this flag restricts the -ea/emptyAll, so that only enableddisk caches (i.e., disk cache nodes with the\n .enableattribute set to true) are affected.\n \n - endTime : et (time) [create,query]\n Specifies the end frame of the cache range.\n \n - frameRangeType : frt (unicode) [create,query]\n Specifies the type of frame range to use, namely Render Globals, Time Slider, and Start/End. In the case of Time\n Slider, startFrame and endFrame need to be specified. (This flag is now obsolete. Please use the -startTime and\n -endTime flags to specify the frame range explicitly.)\n \n - overSample : os (bool) [create,query]\n Over sample if true. Otherwise, under sample.\n \n - samplingRate : sr (int) [create,query]\n Specifies how frequently to sample relative to each frame. When over-sampling (-overSample has been specified), this\n parameter determines how many times per frame the runup will be evaluated. When under-sampling (the default, when\n -overSample has not been specified), the runup will evaluate only once per srframes, where sris the value specified to\n this flag.\n \n - startTime : st (time) [create,query]\n Specifies the start frame of the cache range.\n \n - tempDir : tmp (bool) [create,query]\n Query-only flag for the location of temporary diskCache files. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.diskCache`\n '
pass
|
def diskCache(*args, **kwargs):
'\n Command to create, clear, or close disk cache(s). In query mode, return type is based on queried flag.\n \n Flags:\n - append : a (bool) [create,query]\n Append at the end and not to flush the existing cache\n \n - cacheType : ct (unicode) [create,query]\n Specifies the type of cache to overwrite. mcfpfor particle playback cache, mcfifor particle initial cache. mcjfor\n jiggle cache. This option is only activated during the cache creation.\n \n - close : c (unicode) [create,query]\n Close the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are\n affected.\n \n - closeAll : ca (bool) [create,query]\n Close all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - delete : d (unicode) [create,query]\n Delete the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are\n affected.\n \n - deleteAll : da (bool) [create,query]\n Delete all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - empty : e (unicode) [create,query]\n Clear the content of the disk cache with the given disk cache node name. If -eco/enabledCachesOnly is trueonly enabled\n disk cache nodes are affected.\n \n - emptyAll : ea (bool) [create,query]\n Clear the content of all disk caches. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.\n \n - enabledCachesOnly : eco (bool) [create,query]\n When present, this flag restricts the -ea/emptyAll, so that only enableddisk caches (i.e., disk cache nodes with the\n .enableattribute set to true) are affected.\n \n - endTime : et (time) [create,query]\n Specifies the end frame of the cache range.\n \n - frameRangeType : frt (unicode) [create,query]\n Specifies the type of frame range to use, namely Render Globals, Time Slider, and Start/End. In the case of Time\n Slider, startFrame and endFrame need to be specified. (This flag is now obsolete. Please use the -startTime and\n -endTime flags to specify the frame range explicitly.)\n \n - overSample : os (bool) [create,query]\n Over sample if true. Otherwise, under sample.\n \n - samplingRate : sr (int) [create,query]\n Specifies how frequently to sample relative to each frame. When over-sampling (-overSample has been specified), this\n parameter determines how many times per frame the runup will be evaluated. When under-sampling (the default, when\n -overSample has not been specified), the runup will evaluate only once per srframes, where sris the value specified to\n this flag.\n \n - startTime : st (time) [create,query]\n Specifies the start frame of the cache range.\n \n - tempDir : tmp (bool) [create,query]\n Query-only flag for the location of temporary diskCache files. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.diskCache`\n '
pass<|docstring|>Command to create, clear, or close disk cache(s). In query mode, return type is based on queried flag.
Flags:
- append : a (bool) [create,query]
Append at the end and not to flush the existing cache
- cacheType : ct (unicode) [create,query]
Specifies the type of cache to overwrite. mcfpfor particle playback cache, mcfifor particle initial cache. mcjfor
jiggle cache. This option is only activated during the cache creation.
- close : c (unicode) [create,query]
Close the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are
affected.
- closeAll : ca (bool) [create,query]
Close all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.
- delete : d (unicode) [create,query]
Delete the cache given the disk cache node name. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are
affected.
- deleteAll : da (bool) [create,query]
Delete all disk cache files. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.
- empty : e (unicode) [create,query]
Clear the content of the disk cache with the given disk cache node name. If -eco/enabledCachesOnly is trueonly enabled
disk cache nodes are affected.
- emptyAll : ea (bool) [create,query]
Clear the content of all disk caches. If -eco/enabledCachesOnly is trueonly enabled disk cache nodes are affected.
- enabledCachesOnly : eco (bool) [create,query]
When present, this flag restricts the -ea/emptyAll, so that only enableddisk caches (i.e., disk cache nodes with the
.enableattribute set to true) are affected.
- endTime : et (time) [create,query]
Specifies the end frame of the cache range.
- frameRangeType : frt (unicode) [create,query]
Specifies the type of frame range to use, namely Render Globals, Time Slider, and Start/End. In the case of Time
Slider, startFrame and endFrame need to be specified. (This flag is now obsolete. Please use the -startTime and
-endTime flags to specify the frame range explicitly.)
- overSample : os (bool) [create,query]
Over sample if true. Otherwise, under sample.
- samplingRate : sr (int) [create,query]
Specifies how frequently to sample relative to each frame. When over-sampling (-overSample has been specified), this
parameter determines how many times per frame the runup will be evaluated. When under-sampling (the default, when
-overSample has not been specified), the runup will evaluate only once per srframes, where sris the value specified to
this flag.
- startTime : st (time) [create,query]
Specifies the start frame of the cache range.
- tempDir : tmp (bool) [create,query]
Query-only flag for the location of temporary diskCache files. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.diskCache`<|endoftext|>
|
9c930d62b7656060a5777b51a430150490daa999d14abd7949183ba06f92949c
|
def melInfo(*args, **kwargs):
'\n This command returns the names of all global MEL procedures that are currently defined as a string array. The user can\n query the definition of each MEL procedure using the whatIscommand.\n \n \n Derived from mel command `maya.cmds.melInfo`\n '
pass
|
This command returns the names of all global MEL procedures that are currently defined as a string array. The user can
query the definition of each MEL procedure using the whatIscommand.
Derived from mel command `maya.cmds.melInfo`
|
mayaSDK/pymel/core/system.py
|
melInfo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def melInfo(*args, **kwargs):
'\n This command returns the names of all global MEL procedures that are currently defined as a string array. The user can\n query the definition of each MEL procedure using the whatIscommand.\n \n \n Derived from mel command `maya.cmds.melInfo`\n '
pass
|
def melInfo(*args, **kwargs):
'\n This command returns the names of all global MEL procedures that are currently defined as a string array. The user can\n query the definition of each MEL procedure using the whatIscommand.\n \n \n Derived from mel command `maya.cmds.melInfo`\n '
pass<|docstring|>This command returns the names of all global MEL procedures that are currently defined as a string array. The user can
query the definition of each MEL procedure using the whatIscommand.
Derived from mel command `maya.cmds.melInfo`<|endoftext|>
|
964598c3beb886b2f7e5c3877aab0f2de34fc23263c5619c3065d55c07e13930
|
def exportAnim(exportPath, **kwargs):
'\n Export all animation nodes and animation helper nodes from all objects in the scene. The resulting animation export file will contain connections to objects that are not included in the animation file. As a result, importing/referencing this file back in will require objects of the same name to be present, else errors will occur. The -sns/swapNamespace flag is available for swapping the namespaces of given objects to another namespace. This use of namespaces can be used to re-purpose the animation file to multiple targets using a consistent naming scheme. The exportAnim flag will not export animation layers. For generalized file export of animLayers and other types of nodes, refer to the exportEdits command. Or use the Export Layers functionality. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Export all animation nodes and animation helper nodes from all objects in the scene. The resulting animation export file will contain connections to objects that are not included in the animation file. As a result, importing/referencing this file back in will require objects of the same name to be present, else errors will occur. The -sns/swapNamespace flag is available for swapping the namespaces of given objects to another namespace. This use of namespaces can be used to re-purpose the animation file to multiple targets using a consistent naming scheme. The exportAnim flag will not export animation layers. For generalized file export of animLayers and other types of nodes, refer to the exportEdits command. Or use the Export Layers functionality.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
exportAnim
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def exportAnim(exportPath, **kwargs):
'\n Export all animation nodes and animation helper nodes from all objects in the scene. The resulting animation export file will contain connections to objects that are not included in the animation file. As a result, importing/referencing this file back in will require objects of the same name to be present, else errors will occur. The -sns/swapNamespace flag is available for swapping the namespaces of given objects to another namespace. This use of namespaces can be used to re-purpose the animation file to multiple targets using a consistent naming scheme. The exportAnim flag will not export animation layers. For generalized file export of animLayers and other types of nodes, refer to the exportEdits command. Or use the Export Layers functionality. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def exportAnim(exportPath, **kwargs):
'\n Export all animation nodes and animation helper nodes from all objects in the scene. The resulting animation export file will contain connections to objects that are not included in the animation file. As a result, importing/referencing this file back in will require objects of the same name to be present, else errors will occur. The -sns/swapNamespace flag is available for swapping the namespaces of given objects to another namespace. This use of namespaces can be used to re-purpose the animation file to multiple targets using a consistent naming scheme. The exportAnim flag will not export animation layers. For generalized file export of animLayers and other types of nodes, refer to the exportEdits command. Or use the Export Layers functionality. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Export all animation nodes and animation helper nodes from all objects in the scene. The resulting animation export file will contain connections to objects that are not included in the animation file. As a result, importing/referencing this file back in will require objects of the same name to be present, else errors will occur. The -sns/swapNamespace flag is available for swapping the namespaces of given objects to another namespace. This use of namespaces can be used to re-purpose the animation file to multiple targets using a consistent naming scheme. The exportAnim flag will not export animation layers. For generalized file export of animLayers and other types of nodes, refer to the exportEdits command. Or use the Export Layers functionality.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
e4c390a38eb53bcc4c25c384101c738aec23158f3d09d27bfe609e996a5a6c7c
|
def getModulePath(*args, **kwargs):
'\n Returns the module path for a given module name.\n \n Flags:\n - moduleName : mn (unicode) [create]\n The name of the module whose path you want to retrieve. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.getModulePath`\n '
pass
|
Returns the module path for a given module name.
Flags:
- moduleName : mn (unicode) [create]
The name of the module whose path you want to retrieve. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.getModulePath`
|
mayaSDK/pymel/core/system.py
|
getModulePath
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def getModulePath(*args, **kwargs):
'\n Returns the module path for a given module name.\n \n Flags:\n - moduleName : mn (unicode) [create]\n The name of the module whose path you want to retrieve. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.getModulePath`\n '
pass
|
def getModulePath(*args, **kwargs):
'\n Returns the module path for a given module name.\n \n Flags:\n - moduleName : mn (unicode) [create]\n The name of the module whose path you want to retrieve. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.getModulePath`\n '
pass<|docstring|>Returns the module path for a given module name.
Flags:
- moduleName : mn (unicode) [create]
The name of the module whose path you want to retrieve. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.getModulePath`<|endoftext|>
|
c2793dcc40eb29d5629e879f4fde955a35093eec74495c30eb1f3661034ca5d6
|
def unknownPlugin(*args, **kwargs):
'\n Allows querying of the unknown plug-ins used by the scene, and provides a means to remove them.\n \n Flags:\n - dataTypes : dt (bool) [query]\n Returns the data types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.\n \n - list : l (bool) [query]\n Lists the unknown plug-ins in the scene.\n \n - nodeTypes : nt (bool) [query]\n Returns the node types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.\n \n - remove : r (bool) [create]\n Removes the given unknown plug-in from the scene. For Maya 2014 files and onwards, this will fail if node or data types\n defined by the plug-in are still in use.\n \n - version : v (bool) [query]\n Returns the version string of the given unknown plug-in. Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.unknownPlugin`\n '
pass
|
Allows querying of the unknown plug-ins used by the scene, and provides a means to remove them.
Flags:
- dataTypes : dt (bool) [query]
Returns the data types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.
- list : l (bool) [query]
Lists the unknown plug-ins in the scene.
- nodeTypes : nt (bool) [query]
Returns the node types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.
- remove : r (bool) [create]
Removes the given unknown plug-in from the scene. For Maya 2014 files and onwards, this will fail if node or data types
defined by the plug-in are still in use.
- version : v (bool) [query]
Returns the version string of the given unknown plug-in. Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.unknownPlugin`
|
mayaSDK/pymel/core/system.py
|
unknownPlugin
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def unknownPlugin(*args, **kwargs):
'\n Allows querying of the unknown plug-ins used by the scene, and provides a means to remove them.\n \n Flags:\n - dataTypes : dt (bool) [query]\n Returns the data types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.\n \n - list : l (bool) [query]\n Lists the unknown plug-ins in the scene.\n \n - nodeTypes : nt (bool) [query]\n Returns the node types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.\n \n - remove : r (bool) [create]\n Removes the given unknown plug-in from the scene. For Maya 2014 files and onwards, this will fail if node or data types\n defined by the plug-in are still in use.\n \n - version : v (bool) [query]\n Returns the version string of the given unknown plug-in. Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.unknownPlugin`\n '
pass
|
def unknownPlugin(*args, **kwargs):
'\n Allows querying of the unknown plug-ins used by the scene, and provides a means to remove them.\n \n Flags:\n - dataTypes : dt (bool) [query]\n Returns the data types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.\n \n - list : l (bool) [query]\n Lists the unknown plug-ins in the scene.\n \n - nodeTypes : nt (bool) [query]\n Returns the node types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.\n \n - remove : r (bool) [create]\n Removes the given unknown plug-in from the scene. For Maya 2014 files and onwards, this will fail if node or data types\n defined by the plug-in are still in use.\n \n - version : v (bool) [query]\n Returns the version string of the given unknown plug-in. Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.unknownPlugin`\n '
pass<|docstring|>Allows querying of the unknown plug-ins used by the scene, and provides a means to remove them.
Flags:
- dataTypes : dt (bool) [query]
Returns the data types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.
- list : l (bool) [query]
Lists the unknown plug-ins in the scene.
- nodeTypes : nt (bool) [query]
Returns the node types associated with the given unknown plug-in. This will always be empty for pre-Maya 2014 files.
- remove : r (bool) [create]
Removes the given unknown plug-in from the scene. For Maya 2014 files and onwards, this will fail if node or data types
defined by the plug-in are still in use.
- version : v (bool) [query]
Returns the version string of the given unknown plug-in. Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.unknownPlugin`<|endoftext|>
|
cbcdfae4a60bcb3a722d60311b263ccb659c5b0e1f96ad9692d5b5fda72672f4
|
def setAttrMapping(*args, **kwargs):
'\n This command applies an offset and scale to a specified device attachment. This command is different than the\n setInputDeviceMapping command, which applies a mapping to a device axis. The value from the device is multiplied by the\n scale and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting\n value. If the mapping is relative, the resulting value is added to the previous calculated value. The calculated value\n will also take into account the setInputDeviceMapping, if it was defined. As an example, if the space ball is setup with\n absolute attachment mappings, pressing in one direction will cause the attached attribute to get a constant value. If a\n relative mapping is used, and the spaceball is pressed in one direction, the attached attribute will get a constantly\n increasing (or constantly decreasing) value. Note that the definition of relative is different than the definition used\n by the setInputDeviceMapping command. In general, both a relative attachment mapping (this command) and a relative\n device mapping (setInputDeviceMapping) should not be used together one the same axis. In query mode, return type is\n based on queried flag.\n \n Dynamic library stub function\n \n Flags:\n - absolute : a (bool) [create]\n Make the mapping absolute.\n \n - attribute : at (unicode) [create]\n The attribute used in the attachment.\n \n - axis : ax (unicode) [create]\n The axis on the device used in the attachment.\n \n - clutch : c (unicode) [create]\n The clutch button used in the attachment.\n \n - device : d (unicode) [create]\n The device used in the attachment.\n \n - offset : o (float) [create]\n Specify the offset value.\n \n - relative : r (bool) [create]\n Make the mapping relative.\n \n - scale : s (float) [create]\n Specify the scale value.\n \n - selection : sl (bool) [create]\n This flag specifies the mapping should be on the selected objects Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.setAttrMapping`\n '
pass
|
This command applies an offset and scale to a specified device attachment. This command is different than the
setInputDeviceMapping command, which applies a mapping to a device axis. The value from the device is multiplied by the
scale and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting
value. If the mapping is relative, the resulting value is added to the previous calculated value. The calculated value
will also take into account the setInputDeviceMapping, if it was defined. As an example, if the space ball is setup with
absolute attachment mappings, pressing in one direction will cause the attached attribute to get a constant value. If a
relative mapping is used, and the spaceball is pressed in one direction, the attached attribute will get a constantly
increasing (or constantly decreasing) value. Note that the definition of relative is different than the definition used
by the setInputDeviceMapping command. In general, both a relative attachment mapping (this command) and a relative
device mapping (setInputDeviceMapping) should not be used together one the same axis. In query mode, return type is
based on queried flag.
Dynamic library stub function
Flags:
- absolute : a (bool) [create]
Make the mapping absolute.
- attribute : at (unicode) [create]
The attribute used in the attachment.
- axis : ax (unicode) [create]
The axis on the device used in the attachment.
- clutch : c (unicode) [create]
The clutch button used in the attachment.
- device : d (unicode) [create]
The device used in the attachment.
- offset : o (float) [create]
Specify the offset value.
- relative : r (bool) [create]
Make the mapping relative.
- scale : s (float) [create]
Specify the scale value.
- selection : sl (bool) [create]
This flag specifies the mapping should be on the selected objects Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.setAttrMapping`
|
mayaSDK/pymel/core/system.py
|
setAttrMapping
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def setAttrMapping(*args, **kwargs):
'\n This command applies an offset and scale to a specified device attachment. This command is different than the\n setInputDeviceMapping command, which applies a mapping to a device axis. The value from the device is multiplied by the\n scale and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting\n value. If the mapping is relative, the resulting value is added to the previous calculated value. The calculated value\n will also take into account the setInputDeviceMapping, if it was defined. As an example, if the space ball is setup with\n absolute attachment mappings, pressing in one direction will cause the attached attribute to get a constant value. If a\n relative mapping is used, and the spaceball is pressed in one direction, the attached attribute will get a constantly\n increasing (or constantly decreasing) value. Note that the definition of relative is different than the definition used\n by the setInputDeviceMapping command. In general, both a relative attachment mapping (this command) and a relative\n device mapping (setInputDeviceMapping) should not be used together one the same axis. In query mode, return type is\n based on queried flag.\n \n Dynamic library stub function\n \n Flags:\n - absolute : a (bool) [create]\n Make the mapping absolute.\n \n - attribute : at (unicode) [create]\n The attribute used in the attachment.\n \n - axis : ax (unicode) [create]\n The axis on the device used in the attachment.\n \n - clutch : c (unicode) [create]\n The clutch button used in the attachment.\n \n - device : d (unicode) [create]\n The device used in the attachment.\n \n - offset : o (float) [create]\n Specify the offset value.\n \n - relative : r (bool) [create]\n Make the mapping relative.\n \n - scale : s (float) [create]\n Specify the scale value.\n \n - selection : sl (bool) [create]\n This flag specifies the mapping should be on the selected objects Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.setAttrMapping`\n '
pass
|
def setAttrMapping(*args, **kwargs):
'\n This command applies an offset and scale to a specified device attachment. This command is different than the\n setInputDeviceMapping command, which applies a mapping to a device axis. The value from the device is multiplied by the\n scale and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting\n value. If the mapping is relative, the resulting value is added to the previous calculated value. The calculated value\n will also take into account the setInputDeviceMapping, if it was defined. As an example, if the space ball is setup with\n absolute attachment mappings, pressing in one direction will cause the attached attribute to get a constant value. If a\n relative mapping is used, and the spaceball is pressed in one direction, the attached attribute will get a constantly\n increasing (or constantly decreasing) value. Note that the definition of relative is different than the definition used\n by the setInputDeviceMapping command. In general, both a relative attachment mapping (this command) and a relative\n device mapping (setInputDeviceMapping) should not be used together one the same axis. In query mode, return type is\n based on queried flag.\n \n Dynamic library stub function\n \n Flags:\n - absolute : a (bool) [create]\n Make the mapping absolute.\n \n - attribute : at (unicode) [create]\n The attribute used in the attachment.\n \n - axis : ax (unicode) [create]\n The axis on the device used in the attachment.\n \n - clutch : c (unicode) [create]\n The clutch button used in the attachment.\n \n - device : d (unicode) [create]\n The device used in the attachment.\n \n - offset : o (float) [create]\n Specify the offset value.\n \n - relative : r (bool) [create]\n Make the mapping relative.\n \n - scale : s (float) [create]\n Specify the scale value.\n \n - selection : sl (bool) [create]\n This flag specifies the mapping should be on the selected objects Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.setAttrMapping`\n '
pass<|docstring|>This command applies an offset and scale to a specified device attachment. This command is different than the
setInputDeviceMapping command, which applies a mapping to a device axis. The value from the device is multiplied by the
scale and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting
value. If the mapping is relative, the resulting value is added to the previous calculated value. The calculated value
will also take into account the setInputDeviceMapping, if it was defined. As an example, if the space ball is setup with
absolute attachment mappings, pressing in one direction will cause the attached attribute to get a constant value. If a
relative mapping is used, and the spaceball is pressed in one direction, the attached attribute will get a constantly
increasing (or constantly decreasing) value. Note that the definition of relative is different than the definition used
by the setInputDeviceMapping command. In general, both a relative attachment mapping (this command) and a relative
device mapping (setInputDeviceMapping) should not be used together one the same axis. In query mode, return type is
based on queried flag.
Dynamic library stub function
Flags:
- absolute : a (bool) [create]
Make the mapping absolute.
- attribute : at (unicode) [create]
The attribute used in the attachment.
- axis : ax (unicode) [create]
The axis on the device used in the attachment.
- clutch : c (unicode) [create]
The clutch button used in the attachment.
- device : d (unicode) [create]
The device used in the attachment.
- offset : o (float) [create]
Specify the offset value.
- relative : r (bool) [create]
Make the mapping relative.
- scale : s (float) [create]
Specify the scale value.
- selection : sl (bool) [create]
This flag specifies the mapping should be on the selected objects Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.setAttrMapping`<|endoftext|>
|
29d79390a970805bc6fe6155cb24469c328a1f8b7d85065edb7eb7d428c1fa36
|
def deviceEditor(*args, **kwargs):
'\n This creates an editor for creating/modifying attachments to input devices.\n \n Dynamic library stub function\n \n Flags:\n - control : ctl (bool) [query]\n Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.\n Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Attaches a tag to the editor.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - filter : f (unicode) [create,query,edit]\n Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the\n main list of the editor.\n \n - forceMainConnection : fmc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in\n that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the\n -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.\n \n - highlightConnection : hlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all\n editors have a highlight list. For those that do, it is a secondary selection list.\n \n - lockMainConnection : lck (bool) [create,edit]\n Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.\n Further changes to the original mainConnection are ignored.\n \n - mainListConnection : mlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object.\n \n - panel : pnl (unicode) [create,query]\n Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it\n will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is\n deleted.\n \n - parent : p (unicode) [create,query,edit]\n Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.\n \n - selectionConnection : slc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the\n user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes\n changes, the editor updates to show the changes.\n \n - stateString : sts (bool) [query]\n Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned\n command string uses the string variable $editorName in place of a specific name.\n \n - takePath : tp (unicode) [query,edit]\n The path used for writing/reading take data through the editor.\n \n - unParent : up (bool) [create,edit]\n Specifies that the editor should be removed from its layout. This cannot be used in query mode.\n \n - unlockMainConnection : ulk (bool) [create,edit]\n Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic\n updates.\n \n - updateMainConnection : upd (bool) [create,edit]\n Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.deviceEditor`\n '
pass
|
This creates an editor for creating/modifying attachments to input devices.
Dynamic library stub function
Flags:
- control : ctl (bool) [query]
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.
- defineTemplate : dt (unicode) [create]
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the
argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
as the current template.
- docTag : dtg (unicode) [create,query,edit]
Attaches a tag to the editor.
- exists : ex (bool) [create]
Returns whether the specified object exists or not. Other flags are ignored.
- filter : f (unicode) [create,query,edit]
Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the
main list of the editor.
- forceMainConnection : fmc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
-unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
- highlightConnection : hlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all
editors have a highlight list. For those that do, it is a secondary selection list.
- lockMainConnection : lck (bool) [create,edit]
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
Further changes to the original mainConnection are ignored.
- mainListConnection : mlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object.
- panel : pnl (unicode) [create,query]
Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it
will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is
deleted.
- parent : p (unicode) [create,query,edit]
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
- selectionConnection : slc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the
user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
changes, the editor updates to show the changes.
- stateString : sts (bool) [query]
Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned
command string uses the string variable $editorName in place of a specific name.
- takePath : tp (unicode) [query,edit]
The path used for writing/reading take data through the editor.
- unParent : up (bool) [create,edit]
Specifies that the editor should be removed from its layout. This cannot be used in query mode.
- unlockMainConnection : ulk (bool) [create,edit]
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
updates.
- updateMainConnection : upd (bool) [create,edit]
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
- useTemplate : ut (unicode) [create]
Forces the command to use a command template other than the current one. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.deviceEditor`
|
mayaSDK/pymel/core/system.py
|
deviceEditor
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def deviceEditor(*args, **kwargs):
'\n This creates an editor for creating/modifying attachments to input devices.\n \n Dynamic library stub function\n \n Flags:\n - control : ctl (bool) [query]\n Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.\n Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Attaches a tag to the editor.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - filter : f (unicode) [create,query,edit]\n Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the\n main list of the editor.\n \n - forceMainConnection : fmc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in\n that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the\n -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.\n \n - highlightConnection : hlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all\n editors have a highlight list. For those that do, it is a secondary selection list.\n \n - lockMainConnection : lck (bool) [create,edit]\n Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.\n Further changes to the original mainConnection are ignored.\n \n - mainListConnection : mlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object.\n \n - panel : pnl (unicode) [create,query]\n Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it\n will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is\n deleted.\n \n - parent : p (unicode) [create,query,edit]\n Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.\n \n - selectionConnection : slc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the\n user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes\n changes, the editor updates to show the changes.\n \n - stateString : sts (bool) [query]\n Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned\n command string uses the string variable $editorName in place of a specific name.\n \n - takePath : tp (unicode) [query,edit]\n The path used for writing/reading take data through the editor.\n \n - unParent : up (bool) [create,edit]\n Specifies that the editor should be removed from its layout. This cannot be used in query mode.\n \n - unlockMainConnection : ulk (bool) [create,edit]\n Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic\n updates.\n \n - updateMainConnection : upd (bool) [create,edit]\n Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.deviceEditor`\n '
pass
|
def deviceEditor(*args, **kwargs):
'\n This creates an editor for creating/modifying attachments to input devices.\n \n Dynamic library stub function\n \n Flags:\n - control : ctl (bool) [query]\n Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.\n Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Attaches a tag to the editor.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - filter : f (unicode) [create,query,edit]\n Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the\n main list of the editor.\n \n - forceMainConnection : fmc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in\n that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the\n -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.\n \n - highlightConnection : hlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all\n editors have a highlight list. For those that do, it is a secondary selection list.\n \n - lockMainConnection : lck (bool) [create,edit]\n Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.\n Further changes to the original mainConnection are ignored.\n \n - mainListConnection : mlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object.\n \n - panel : pnl (unicode) [create,query]\n Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it\n will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is\n deleted.\n \n - parent : p (unicode) [create,query,edit]\n Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.\n \n - selectionConnection : slc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the\n user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes\n changes, the editor updates to show the changes.\n \n - stateString : sts (bool) [query]\n Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned\n command string uses the string variable $editorName in place of a specific name.\n \n - takePath : tp (unicode) [query,edit]\n The path used for writing/reading take data through the editor.\n \n - unParent : up (bool) [create,edit]\n Specifies that the editor should be removed from its layout. This cannot be used in query mode.\n \n - unlockMainConnection : ulk (bool) [create,edit]\n Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic\n updates.\n \n - updateMainConnection : upd (bool) [create,edit]\n Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.deviceEditor`\n '
pass<|docstring|>This creates an editor for creating/modifying attachments to input devices.
Dynamic library stub function
Flags:
- control : ctl (bool) [query]
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.
- defineTemplate : dt (unicode) [create]
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the
argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
as the current template.
- docTag : dtg (unicode) [create,query,edit]
Attaches a tag to the editor.
- exists : ex (bool) [create]
Returns whether the specified object exists or not. Other flags are ignored.
- filter : f (unicode) [create,query,edit]
Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the
main list of the editor.
- forceMainConnection : fmc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
-unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
- highlightConnection : hlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all
editors have a highlight list. For those that do, it is a secondary selection list.
- lockMainConnection : lck (bool) [create,edit]
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
Further changes to the original mainConnection are ignored.
- mainListConnection : mlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object.
- panel : pnl (unicode) [create,query]
Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it
will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is
deleted.
- parent : p (unicode) [create,query,edit]
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
- selectionConnection : slc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the
user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
changes, the editor updates to show the changes.
- stateString : sts (bool) [query]
Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned
command string uses the string variable $editorName in place of a specific name.
- takePath : tp (unicode) [query,edit]
The path used for writing/reading take data through the editor.
- unParent : up (bool) [create,edit]
Specifies that the editor should be removed from its layout. This cannot be used in query mode.
- unlockMainConnection : ulk (bool) [create,edit]
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
updates.
- updateMainConnection : upd (bool) [create,edit]
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
- useTemplate : ut (unicode) [create]
Forces the command to use a command template other than the current one. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.deviceEditor`<|endoftext|>
|
dbaa6b94c44266ba4a0e5c2bc6145389267cd1e7e04e5a160764f3f76d269b5d
|
def fileBrowserDialog(*args, **kwargs):
'\n The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is\n recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both\n fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the\n fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be\n able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an\n example of how to change a script to use fileDialog2.\n \n Flags:\n - actionName : an (unicode) [create]\n Script to be called when the file is validated.\n \n - dialogStyle : ds (int) [create]\n 0 for old style dialog1 for Windows 2000 style Explorer style2 for Explorer style with Shortcuttip at bottom\n \n - fileCommand : fc (script) [create]\n The script to run on command action\n \n - fileType : ft (unicode) [create]\n Set the type of file to filter. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Illustrator, image. plug-ins may define their own types as well.\n \n - filterList : fl (unicode) [create]\n Specify file filters. Used with dialog style 1 and 2. Each string should be a description followed by a comma followed\n by a semi-colon separated list of file extensions with wildcard.\n \n - includeName : includeName (unicode) [create]\n Include the given string after the actionName in parentheses. If the name is too long, it will be shortened to fit on\n the dialog (for example, /usr/alias/commands/scripts/fileBrowser.mel might be shortened to /usr/...pts/fileBrowser.mel)\n \n - mode : m (int) [create]\n Defines the mode in which to run the file brower: 0 for read1 for write2 for write without paths (segmented files)4 for\n directories have meaning when used with the action+100 for returning short names\n \n - operationMode : om (unicode) [create]\n Enables the option dialog. Valid strings are: ImportReferenceSaveAsExportAllExportActive\n \n - tipMessage : tm (unicode) [create]\n Message to be displayed at the bottom of the style 2 dialog box.\n \n - windowTitle : wt (unicode) [create]\n Set the window title of a style 1 or 2 dialog box Flag can have multiple arguments, passed either as a\n tuple or a list.\n \n \n Derived from mel command `maya.cmds.fileBrowserDialog`\n '
pass
|
The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is
recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both
fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the
fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be
able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an
example of how to change a script to use fileDialog2.
Flags:
- actionName : an (unicode) [create]
Script to be called when the file is validated.
- dialogStyle : ds (int) [create]
0 for old style dialog1 for Windows 2000 style Explorer style2 for Explorer style with Shortcuttip at bottom
- fileCommand : fc (script) [create]
The script to run on command action
- fileType : ft (unicode) [create]
Set the type of file to filter. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Illustrator, image. plug-ins may define their own types as well.
- filterList : fl (unicode) [create]
Specify file filters. Used with dialog style 1 and 2. Each string should be a description followed by a comma followed
by a semi-colon separated list of file extensions with wildcard.
- includeName : includeName (unicode) [create]
Include the given string after the actionName in parentheses. If the name is too long, it will be shortened to fit on
the dialog (for example, /usr/alias/commands/scripts/fileBrowser.mel might be shortened to /usr/...pts/fileBrowser.mel)
- mode : m (int) [create]
Defines the mode in which to run the file brower: 0 for read1 for write2 for write without paths (segmented files)4 for
directories have meaning when used with the action+100 for returning short names
- operationMode : om (unicode) [create]
Enables the option dialog. Valid strings are: ImportReferenceSaveAsExportAllExportActive
- tipMessage : tm (unicode) [create]
Message to be displayed at the bottom of the style 2 dialog box.
- windowTitle : wt (unicode) [create]
Set the window title of a style 1 or 2 dialog box Flag can have multiple arguments, passed either as a
tuple or a list.
Derived from mel command `maya.cmds.fileBrowserDialog`
|
mayaSDK/pymel/core/system.py
|
fileBrowserDialog
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def fileBrowserDialog(*args, **kwargs):
'\n The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is\n recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both\n fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the\n fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be\n able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an\n example of how to change a script to use fileDialog2.\n \n Flags:\n - actionName : an (unicode) [create]\n Script to be called when the file is validated.\n \n - dialogStyle : ds (int) [create]\n 0 for old style dialog1 for Windows 2000 style Explorer style2 for Explorer style with Shortcuttip at bottom\n \n - fileCommand : fc (script) [create]\n The script to run on command action\n \n - fileType : ft (unicode) [create]\n Set the type of file to filter. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Illustrator, image. plug-ins may define their own types as well.\n \n - filterList : fl (unicode) [create]\n Specify file filters. Used with dialog style 1 and 2. Each string should be a description followed by a comma followed\n by a semi-colon separated list of file extensions with wildcard.\n \n - includeName : includeName (unicode) [create]\n Include the given string after the actionName in parentheses. If the name is too long, it will be shortened to fit on\n the dialog (for example, /usr/alias/commands/scripts/fileBrowser.mel might be shortened to /usr/...pts/fileBrowser.mel)\n \n - mode : m (int) [create]\n Defines the mode in which to run the file brower: 0 for read1 for write2 for write without paths (segmented files)4 for\n directories have meaning when used with the action+100 for returning short names\n \n - operationMode : om (unicode) [create]\n Enables the option dialog. Valid strings are: ImportReferenceSaveAsExportAllExportActive\n \n - tipMessage : tm (unicode) [create]\n Message to be displayed at the bottom of the style 2 dialog box.\n \n - windowTitle : wt (unicode) [create]\n Set the window title of a style 1 or 2 dialog box Flag can have multiple arguments, passed either as a\n tuple or a list.\n \n \n Derived from mel command `maya.cmds.fileBrowserDialog`\n '
pass
|
def fileBrowserDialog(*args, **kwargs):
'\n The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is\n recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both\n fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the\n fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be\n able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an\n example of how to change a script to use fileDialog2.\n \n Flags:\n - actionName : an (unicode) [create]\n Script to be called when the file is validated.\n \n - dialogStyle : ds (int) [create]\n 0 for old style dialog1 for Windows 2000 style Explorer style2 for Explorer style with Shortcuttip at bottom\n \n - fileCommand : fc (script) [create]\n The script to run on command action\n \n - fileType : ft (unicode) [create]\n Set the type of file to filter. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Illustrator, image. plug-ins may define their own types as well.\n \n - filterList : fl (unicode) [create]\n Specify file filters. Used with dialog style 1 and 2. Each string should be a description followed by a comma followed\n by a semi-colon separated list of file extensions with wildcard.\n \n - includeName : includeName (unicode) [create]\n Include the given string after the actionName in parentheses. If the name is too long, it will be shortened to fit on\n the dialog (for example, /usr/alias/commands/scripts/fileBrowser.mel might be shortened to /usr/...pts/fileBrowser.mel)\n \n - mode : m (int) [create]\n Defines the mode in which to run the file brower: 0 for read1 for write2 for write without paths (segmented files)4 for\n directories have meaning when used with the action+100 for returning short names\n \n - operationMode : om (unicode) [create]\n Enables the option dialog. Valid strings are: ImportReferenceSaveAsExportAllExportActive\n \n - tipMessage : tm (unicode) [create]\n Message to be displayed at the bottom of the style 2 dialog box.\n \n - windowTitle : wt (unicode) [create]\n Set the window title of a style 1 or 2 dialog box Flag can have multiple arguments, passed either as a\n tuple or a list.\n \n \n Derived from mel command `maya.cmds.fileBrowserDialog`\n '
pass<|docstring|>The fileBrowserDialog and fileDialog commands have now been deprecated. Both commands are still callable, but it is
recommended that the fileDialog2 command be used instead. To maintain some backwards compatibility, both
fileBrowserDialog and fileDialog will convert the flags/values passed to them into the appropriate flags/values that the
fileDialog2 command uses and will call that command internally. It is not guaranteed that this compatibility will be
able to be maintained in future versions so any new scripts that are written should use fileDialog2. See below for an
example of how to change a script to use fileDialog2.
Flags:
- actionName : an (unicode) [create]
Script to be called when the file is validated.
- dialogStyle : ds (int) [create]
0 for old style dialog1 for Windows 2000 style Explorer style2 for Explorer style with Shortcuttip at bottom
- fileCommand : fc (script) [create]
The script to run on command action
- fileType : ft (unicode) [create]
Set the type of file to filter. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Illustrator, image. plug-ins may define their own types as well.
- filterList : fl (unicode) [create]
Specify file filters. Used with dialog style 1 and 2. Each string should be a description followed by a comma followed
by a semi-colon separated list of file extensions with wildcard.
- includeName : includeName (unicode) [create]
Include the given string after the actionName in parentheses. If the name is too long, it will be shortened to fit on
the dialog (for example, /usr/alias/commands/scripts/fileBrowser.mel might be shortened to /usr/...pts/fileBrowser.mel)
- mode : m (int) [create]
Defines the mode in which to run the file brower: 0 for read1 for write2 for write without paths (segmented files)4 for
directories have meaning when used with the action+100 for returning short names
- operationMode : om (unicode) [create]
Enables the option dialog. Valid strings are: ImportReferenceSaveAsExportAllExportActive
- tipMessage : tm (unicode) [create]
Message to be displayed at the bottom of the style 2 dialog box.
- windowTitle : wt (unicode) [create]
Set the window title of a style 1 or 2 dialog box Flag can have multiple arguments, passed either as a
tuple or a list.
Derived from mel command `maya.cmds.fileBrowserDialog`<|endoftext|>
|
f9abc8cbd54ff685550eb679bc71b6ad9aa8b44d076030b84654aef655c1abfd
|
def mouse(*args, **kwargs):
'\n This command allows to configure mouse.\n \n Flags:\n - enableScrollWheel : esw (bool) [create]\n Enable or disable scroll wheel support.\n \n - mouseButtonTracking : mbt (int) [create]\n Set the number (1, 2 or 3) of mouse buttons to track.Note: this is only supported on Macintosh\n \n - mouseButtonTrackingStatus : mbs (bool) [create]\n returns the current number of mouse buttons being tracked.\n \n - scrollWheelStatus : sws (bool) [create]\n returns the current status of scroll wheel support. Flag can have multiple arguments, passed either as\n a tuple or a list.\n \n \n Derived from mel command `maya.cmds.mouse`\n '
pass
|
This command allows to configure mouse.
Flags:
- enableScrollWheel : esw (bool) [create]
Enable or disable scroll wheel support.
- mouseButtonTracking : mbt (int) [create]
Set the number (1, 2 or 3) of mouse buttons to track.Note: this is only supported on Macintosh
- mouseButtonTrackingStatus : mbs (bool) [create]
returns the current number of mouse buttons being tracked.
- scrollWheelStatus : sws (bool) [create]
returns the current status of scroll wheel support. Flag can have multiple arguments, passed either as
a tuple or a list.
Derived from mel command `maya.cmds.mouse`
|
mayaSDK/pymel/core/system.py
|
mouse
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def mouse(*args, **kwargs):
'\n This command allows to configure mouse.\n \n Flags:\n - enableScrollWheel : esw (bool) [create]\n Enable or disable scroll wheel support.\n \n - mouseButtonTracking : mbt (int) [create]\n Set the number (1, 2 or 3) of mouse buttons to track.Note: this is only supported on Macintosh\n \n - mouseButtonTrackingStatus : mbs (bool) [create]\n returns the current number of mouse buttons being tracked.\n \n - scrollWheelStatus : sws (bool) [create]\n returns the current status of scroll wheel support. Flag can have multiple arguments, passed either as\n a tuple or a list.\n \n \n Derived from mel command `maya.cmds.mouse`\n '
pass
|
def mouse(*args, **kwargs):
'\n This command allows to configure mouse.\n \n Flags:\n - enableScrollWheel : esw (bool) [create]\n Enable or disable scroll wheel support.\n \n - mouseButtonTracking : mbt (int) [create]\n Set the number (1, 2 or 3) of mouse buttons to track.Note: this is only supported on Macintosh\n \n - mouseButtonTrackingStatus : mbs (bool) [create]\n returns the current number of mouse buttons being tracked.\n \n - scrollWheelStatus : sws (bool) [create]\n returns the current status of scroll wheel support. Flag can have multiple arguments, passed either as\n a tuple or a list.\n \n \n Derived from mel command `maya.cmds.mouse`\n '
pass<|docstring|>This command allows to configure mouse.
Flags:
- enableScrollWheel : esw (bool) [create]
Enable or disable scroll wheel support.
- mouseButtonTracking : mbt (int) [create]
Set the number (1, 2 or 3) of mouse buttons to track.Note: this is only supported on Macintosh
- mouseButtonTrackingStatus : mbs (bool) [create]
returns the current number of mouse buttons being tracked.
- scrollWheelStatus : sws (bool) [create]
returns the current status of scroll wheel support. Flag can have multiple arguments, passed either as
a tuple or a list.
Derived from mel command `maya.cmds.mouse`<|endoftext|>
|
f6bfbaeab2572092ee845e1176b78a00c4356838cf295a6c3ba5a332f7a926a0
|
def getFileList(*args, **kwargs):
'\n Returns a list of files matching an optional wildcard pattern. Note that this command works directly on raw system files\n and does not go through standard Maya file path resolution.\n \n Flags:\n - filespec : fs (unicode) [create]\n wildcard specifier for search.\n \n - folder : fld (unicode) [create]\n return a directory listing Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.getFileList`\n '
pass
|
Returns a list of files matching an optional wildcard pattern. Note that this command works directly on raw system files
and does not go through standard Maya file path resolution.
Flags:
- filespec : fs (unicode) [create]
wildcard specifier for search.
- folder : fld (unicode) [create]
return a directory listing Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.getFileList`
|
mayaSDK/pymel/core/system.py
|
getFileList
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def getFileList(*args, **kwargs):
'\n Returns a list of files matching an optional wildcard pattern. Note that this command works directly on raw system files\n and does not go through standard Maya file path resolution.\n \n Flags:\n - filespec : fs (unicode) [create]\n wildcard specifier for search.\n \n - folder : fld (unicode) [create]\n return a directory listing Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.getFileList`\n '
pass
|
def getFileList(*args, **kwargs):
'\n Returns a list of files matching an optional wildcard pattern. Note that this command works directly on raw system files\n and does not go through standard Maya file path resolution.\n \n Flags:\n - filespec : fs (unicode) [create]\n wildcard specifier for search.\n \n - folder : fld (unicode) [create]\n return a directory listing Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.getFileList`\n '
pass<|docstring|>Returns a list of files matching an optional wildcard pattern. Note that this command works directly on raw system files
and does not go through standard Maya file path resolution.
Flags:
- filespec : fs (unicode) [create]
wildcard specifier for search.
- folder : fld (unicode) [create]
return a directory listing Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.getFileList`<|endoftext|>
|
a9aaa652309a8d29fb9963ab19e7cd33eb36839f1169da3ebba6c2860dea98a0
|
def whatsNewHighlight(*args, **kwargs):
"\n This command is used to toggle the What's New highlighting feature, and the display of the settings dialog for the\n feature that appears on startup. In query mode, return type is based on queried flag.\n \n Flags:\n - highlightColor : hc (float, float, float) [create,query]\n Set the color of the What's New highlight. The arguments correspond to the red, green, and blue color components. Each\n color component ranges in value from 0.0 to 1.0.\n \n - highlightOn : ho (bool) [create,query]\n Toggle the What's New highlighting feature. When turned on, menu items and buttons introduced in the latest version will\n be highlighted.\n \n - showStartupDialog : ssd (bool) [create,query]\n Set whether the settings dialog for this feature appears on startup. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.whatsNewHighlight`\n "
pass
|
This command is used to toggle the What's New highlighting feature, and the display of the settings dialog for the
feature that appears on startup. In query mode, return type is based on queried flag.
Flags:
- highlightColor : hc (float, float, float) [create,query]
Set the color of the What's New highlight. The arguments correspond to the red, green, and blue color components. Each
color component ranges in value from 0.0 to 1.0.
- highlightOn : ho (bool) [create,query]
Toggle the What's New highlighting feature. When turned on, menu items and buttons introduced in the latest version will
be highlighted.
- showStartupDialog : ssd (bool) [create,query]
Set whether the settings dialog for this feature appears on startup. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.whatsNewHighlight`
|
mayaSDK/pymel/core/system.py
|
whatsNewHighlight
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def whatsNewHighlight(*args, **kwargs):
"\n This command is used to toggle the What's New highlighting feature, and the display of the settings dialog for the\n feature that appears on startup. In query mode, return type is based on queried flag.\n \n Flags:\n - highlightColor : hc (float, float, float) [create,query]\n Set the color of the What's New highlight. The arguments correspond to the red, green, and blue color components. Each\n color component ranges in value from 0.0 to 1.0.\n \n - highlightOn : ho (bool) [create,query]\n Toggle the What's New highlighting feature. When turned on, menu items and buttons introduced in the latest version will\n be highlighted.\n \n - showStartupDialog : ssd (bool) [create,query]\n Set whether the settings dialog for this feature appears on startup. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.whatsNewHighlight`\n "
pass
|
def whatsNewHighlight(*args, **kwargs):
"\n This command is used to toggle the What's New highlighting feature, and the display of the settings dialog for the\n feature that appears on startup. In query mode, return type is based on queried flag.\n \n Flags:\n - highlightColor : hc (float, float, float) [create,query]\n Set the color of the What's New highlight. The arguments correspond to the red, green, and blue color components. Each\n color component ranges in value from 0.0 to 1.0.\n \n - highlightOn : ho (bool) [create,query]\n Toggle the What's New highlighting feature. When turned on, menu items and buttons introduced in the latest version will\n be highlighted.\n \n - showStartupDialog : ssd (bool) [create,query]\n Set whether the settings dialog for this feature appears on startup. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.whatsNewHighlight`\n "
pass<|docstring|>This command is used to toggle the What's New highlighting feature, and the display of the settings dialog for the
feature that appears on startup. In query mode, return type is based on queried flag.
Flags:
- highlightColor : hc (float, float, float) [create,query]
Set the color of the What's New highlight. The arguments correspond to the red, green, and blue color components. Each
color component ranges in value from 0.0 to 1.0.
- highlightOn : ho (bool) [create,query]
Toggle the What's New highlighting feature. When turned on, menu items and buttons introduced in the latest version will
be highlighted.
- showStartupDialog : ssd (bool) [create,query]
Set whether the settings dialog for this feature appears on startup. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.whatsNewHighlight`<|endoftext|>
|
28304f051450600c76b9095576ee5328d2fad2044e96d2555a5d4c18d22da69f
|
def sceneEditor(*args, **kwargs):
"\n This creates an editor for managing the files in a scene.\n \n Flags:\n - control : ctl (bool) [query]\n Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.\n Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Attaches a tag to the editor.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - filter : f (unicode) [create,query,edit]\n Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the\n main list of the editor.\n \n - forceMainConnection : fmc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in\n that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the\n -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.\n \n - highlightConnection : hlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all\n editors have a highlight list. For those that do, it is a secondary selection list.\n \n - lockMainConnection : lck (bool) [create,edit]\n Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.\n Further changes to the original mainConnection are ignored.\n \n - mainListConnection : mlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object.\n \n - onlyParents : op (bool) [query]\n When used with the 'selectItem' or 'selectReference' queries it indicates that, if both a parent and a child file or\n reference are selected, only the parent will be returned.\n \n - panel : pnl (unicode) [create,query]\n Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it\n will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is\n deleted.\n \n - parent : p (unicode) [create,query,edit]\n Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.\n \n - refreshReferences : rr (bool) [edit]\n Force refresh of references\n \n - selectCommand : sc (script) [create,query,edit]\n A script to be executed when an item is selected.\n \n - selectItem : si (int) [query,edit]\n Query or change the currently selected item. When queried, the currently selected file name will be return.\n \n - selectReference : sr (unicode) [query]\n Query the currently selected reference. Returns the name of the currently selected reference node.\n \n - selectionConnection : slc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the\n user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes\n changes, the editor updates to show the changes.\n \n - shortName : shn (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will be the short name (i.e. just a file\n name without any directory paths). If this flag is not present, the full name and directory path will be returned.\n \n - stateString : sts (bool) [query]\n Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned\n command string uses the string variable $editorName in place of a specific name.\n \n - unParent : up (bool) [create,edit]\n Specifies that the editor should be removed from its layout. This cannot be used in query mode.\n \n - unlockMainConnection : ulk (bool) [create,edit]\n Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic\n updates.\n \n - unresolvedName : un (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will be unresolved (i.e. it will be the\n path originally specified when the file was loaded into Maya; this path may contain environment variables and may not\n exist on disk). If this flag is not present, the resolved name will be returned.\n \n - updateMainConnection : upd (bool) [create,edit]\n Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one.\n \n - withoutCopyNumber : wcn (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will not have a copy number appended to\n the end. If this flag is not present, the file name returned may have a copy number appended to the end.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.sceneEditor`\n "
pass
|
This creates an editor for managing the files in a scene.
Flags:
- control : ctl (bool) [query]
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.
- defineTemplate : dt (unicode) [create]
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the
argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
as the current template.
- docTag : dtg (unicode) [create,query,edit]
Attaches a tag to the editor.
- exists : ex (bool) [create]
Returns whether the specified object exists or not. Other flags are ignored.
- filter : f (unicode) [create,query,edit]
Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the
main list of the editor.
- forceMainConnection : fmc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
-unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
- highlightConnection : hlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all
editors have a highlight list. For those that do, it is a secondary selection list.
- lockMainConnection : lck (bool) [create,edit]
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
Further changes to the original mainConnection are ignored.
- mainListConnection : mlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object.
- onlyParents : op (bool) [query]
When used with the 'selectItem' or 'selectReference' queries it indicates that, if both a parent and a child file or
reference are selected, only the parent will be returned.
- panel : pnl (unicode) [create,query]
Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it
will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is
deleted.
- parent : p (unicode) [create,query,edit]
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
- refreshReferences : rr (bool) [edit]
Force refresh of references
- selectCommand : sc (script) [create,query,edit]
A script to be executed when an item is selected.
- selectItem : si (int) [query,edit]
Query or change the currently selected item. When queried, the currently selected file name will be return.
- selectReference : sr (unicode) [query]
Query the currently selected reference. Returns the name of the currently selected reference node.
- selectionConnection : slc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the
user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
changes, the editor updates to show the changes.
- shortName : shn (bool) [query]
When used with the 'selectItem' query it indicates that the file name returned will be the short name (i.e. just a file
name without any directory paths). If this flag is not present, the full name and directory path will be returned.
- stateString : sts (bool) [query]
Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned
command string uses the string variable $editorName in place of a specific name.
- unParent : up (bool) [create,edit]
Specifies that the editor should be removed from its layout. This cannot be used in query mode.
- unlockMainConnection : ulk (bool) [create,edit]
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
updates.
- unresolvedName : un (bool) [query]
When used with the 'selectItem' query it indicates that the file name returned will be unresolved (i.e. it will be the
path originally specified when the file was loaded into Maya; this path may contain environment variables and may not
exist on disk). If this flag is not present, the resolved name will be returned.
- updateMainConnection : upd (bool) [create,edit]
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
- useTemplate : ut (unicode) [create]
Forces the command to use a command template other than the current one.
- withoutCopyNumber : wcn (bool) [query]
When used with the 'selectItem' query it indicates that the file name returned will not have a copy number appended to
the end. If this flag is not present, the file name returned may have a copy number appended to the end.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.sceneEditor`
|
mayaSDK/pymel/core/system.py
|
sceneEditor
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def sceneEditor(*args, **kwargs):
"\n This creates an editor for managing the files in a scene.\n \n Flags:\n - control : ctl (bool) [query]\n Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.\n Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Attaches a tag to the editor.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - filter : f (unicode) [create,query,edit]\n Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the\n main list of the editor.\n \n - forceMainConnection : fmc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in\n that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the\n -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.\n \n - highlightConnection : hlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all\n editors have a highlight list. For those that do, it is a secondary selection list.\n \n - lockMainConnection : lck (bool) [create,edit]\n Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.\n Further changes to the original mainConnection are ignored.\n \n - mainListConnection : mlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object.\n \n - onlyParents : op (bool) [query]\n When used with the 'selectItem' or 'selectReference' queries it indicates that, if both a parent and a child file or\n reference are selected, only the parent will be returned.\n \n - panel : pnl (unicode) [create,query]\n Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it\n will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is\n deleted.\n \n - parent : p (unicode) [create,query,edit]\n Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.\n \n - refreshReferences : rr (bool) [edit]\n Force refresh of references\n \n - selectCommand : sc (script) [create,query,edit]\n A script to be executed when an item is selected.\n \n - selectItem : si (int) [query,edit]\n Query or change the currently selected item. When queried, the currently selected file name will be return.\n \n - selectReference : sr (unicode) [query]\n Query the currently selected reference. Returns the name of the currently selected reference node.\n \n - selectionConnection : slc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the\n user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes\n changes, the editor updates to show the changes.\n \n - shortName : shn (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will be the short name (i.e. just a file\n name without any directory paths). If this flag is not present, the full name and directory path will be returned.\n \n - stateString : sts (bool) [query]\n Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned\n command string uses the string variable $editorName in place of a specific name.\n \n - unParent : up (bool) [create,edit]\n Specifies that the editor should be removed from its layout. This cannot be used in query mode.\n \n - unlockMainConnection : ulk (bool) [create,edit]\n Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic\n updates.\n \n - unresolvedName : un (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will be unresolved (i.e. it will be the\n path originally specified when the file was loaded into Maya; this path may contain environment variables and may not\n exist on disk). If this flag is not present, the resolved name will be returned.\n \n - updateMainConnection : upd (bool) [create,edit]\n Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one.\n \n - withoutCopyNumber : wcn (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will not have a copy number appended to\n the end. If this flag is not present, the file name returned may have a copy number appended to the end.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.sceneEditor`\n "
pass
|
def sceneEditor(*args, **kwargs):
"\n This creates an editor for managing the files in a scene.\n \n Flags:\n - control : ctl (bool) [query]\n Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.\n Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.\n \n - defineTemplate : dt (unicode) [create]\n Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the\n argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set\n as the current template.\n \n - docTag : dtg (unicode) [create,query,edit]\n Attaches a tag to the editor.\n \n - exists : ex (bool) [create]\n Returns whether the specified object exists or not. Other flags are ignored.\n \n - filter : f (unicode) [create,query,edit]\n Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the\n main list of the editor.\n \n - forceMainConnection : fmc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in\n that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the\n -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.\n \n - highlightConnection : hlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all\n editors have a highlight list. For those that do, it is a secondary selection list.\n \n - lockMainConnection : lck (bool) [create,edit]\n Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.\n Further changes to the original mainConnection are ignored.\n \n - mainListConnection : mlc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will\n only display items contained in the selectionConnection object.\n \n - onlyParents : op (bool) [query]\n When used with the 'selectItem' or 'selectReference' queries it indicates that, if both a parent and a child file or\n reference are selected, only the parent will be returned.\n \n - panel : pnl (unicode) [create,query]\n Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it\n will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is\n deleted.\n \n - parent : p (unicode) [create,query,edit]\n Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.\n \n - refreshReferences : rr (bool) [edit]\n Force refresh of references\n \n - selectCommand : sc (script) [create,query,edit]\n A script to be executed when an item is selected.\n \n - selectItem : si (int) [query,edit]\n Query or change the currently selected item. When queried, the currently selected file name will be return.\n \n - selectReference : sr (unicode) [query]\n Query the currently selected reference. Returns the name of the currently selected reference node.\n \n - selectionConnection : slc (unicode) [create,query,edit]\n Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the\n user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes\n changes, the editor updates to show the changes.\n \n - shortName : shn (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will be the short name (i.e. just a file\n name without any directory paths). If this flag is not present, the full name and directory path will be returned.\n \n - stateString : sts (bool) [query]\n Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned\n command string uses the string variable $editorName in place of a specific name.\n \n - unParent : up (bool) [create,edit]\n Specifies that the editor should be removed from its layout. This cannot be used in query mode.\n \n - unlockMainConnection : ulk (bool) [create,edit]\n Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic\n updates.\n \n - unresolvedName : un (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will be unresolved (i.e. it will be the\n path originally specified when the file was loaded into Maya; this path may contain environment variables and may not\n exist on disk). If this flag is not present, the resolved name will be returned.\n \n - updateMainConnection : upd (bool) [create,edit]\n Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.\n \n - useTemplate : ut (unicode) [create]\n Forces the command to use a command template other than the current one.\n \n - withoutCopyNumber : wcn (bool) [query]\n When used with the 'selectItem' query it indicates that the file name returned will not have a copy number appended to\n the end. If this flag is not present, the file name returned may have a copy number appended to the end.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.sceneEditor`\n "
pass<|docstring|>This creates an editor for managing the files in a scene.
Flags:
- control : ctl (bool) [query]
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus.
Caution: It is possible for an editor to exist without a control. The query will return NONEif no control is present.
- defineTemplate : dt (unicode) [create]
Puts the command in a mode where any other flags and args are parsed and added to the command template specified in the
argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set
as the current template.
- docTag : dtg (unicode) [create,query,edit]
Attaches a tag to the editor.
- exists : ex (bool) [create]
Returns whether the specified object exists or not. Other flags are ignored.
- filter : f (unicode) [create,query,edit]
Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the
main list of the editor.
- forceMainConnection : fmc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in
that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the
-unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
- highlightConnection : hlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all
editors have a highlight list. For those that do, it is a secondary selection list.
- lockMainConnection : lck (bool) [create,edit]
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor.
Further changes to the original mainConnection are ignored.
- mainListConnection : mlc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will
only display items contained in the selectionConnection object.
- onlyParents : op (bool) [query]
When used with the 'selectItem' or 'selectReference' queries it indicates that, if both a parent and a child file or
reference are selected, only the parent will be returned.
- panel : pnl (unicode) [create,query]
Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it
will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is
deleted.
- parent : p (unicode) [create,query,edit]
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
- refreshReferences : rr (bool) [edit]
Force refresh of references
- selectCommand : sc (script) [create,query,edit]
A script to be executed when an item is selected.
- selectItem : si (int) [query,edit]
Query or change the currently selected item. When queried, the currently selected file name will be return.
- selectReference : sr (unicode) [query]
Query the currently selected reference. Returns the name of the currently selected reference node.
- selectionConnection : slc (unicode) [create,query,edit]
Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the
user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes
changes, the editor updates to show the changes.
- shortName : shn (bool) [query]
When used with the 'selectItem' query it indicates that the file name returned will be the short name (i.e. just a file
name without any directory paths). If this flag is not present, the full name and directory path will be returned.
- stateString : sts (bool) [query]
Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned
command string uses the string variable $editorName in place of a specific name.
- unParent : up (bool) [create,edit]
Specifies that the editor should be removed from its layout. This cannot be used in query mode.
- unlockMainConnection : ulk (bool) [create,edit]
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic
updates.
- unresolvedName : un (bool) [query]
When used with the 'selectItem' query it indicates that the file name returned will be unresolved (i.e. it will be the
path originally specified when the file was loaded into Maya; this path may contain environment variables and may not
exist on disk). If this flag is not present, the resolved name will be returned.
- updateMainConnection : upd (bool) [create,edit]
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
- useTemplate : ut (unicode) [create]
Forces the command to use a command template other than the current one.
- withoutCopyNumber : wcn (bool) [query]
When used with the 'selectItem' query it indicates that the file name returned will not have a copy number appended to
the end. If this flag is not present, the file name returned may have a copy number appended to the end.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.sceneEditor`<|endoftext|>
|
6343c1e371a5d7d31b63ec67ff4553ca4ace33b78f841d750780257f39730342
|
def unassignInputDevice(*args, **kwargs):
'\n This command deletes all command strings associated with this device. In query mode, return type is based on queried\n flag.\n \n Dynamic library stub function\n \n Flags:\n - clutch : c (unicode) [create]\n Only delete command attachments with this clutch.\n \n - device : d (unicode) [create]\n Specifies the device to work on. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.unassignInputDevice`\n '
pass
|
This command deletes all command strings associated with this device. In query mode, return type is based on queried
flag.
Dynamic library stub function
Flags:
- clutch : c (unicode) [create]
Only delete command attachments with this clutch.
- device : d (unicode) [create]
Specifies the device to work on. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.unassignInputDevice`
|
mayaSDK/pymel/core/system.py
|
unassignInputDevice
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def unassignInputDevice(*args, **kwargs):
'\n This command deletes all command strings associated with this device. In query mode, return type is based on queried\n flag.\n \n Dynamic library stub function\n \n Flags:\n - clutch : c (unicode) [create]\n Only delete command attachments with this clutch.\n \n - device : d (unicode) [create]\n Specifies the device to work on. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.unassignInputDevice`\n '
pass
|
def unassignInputDevice(*args, **kwargs):
'\n This command deletes all command strings associated with this device. In query mode, return type is based on queried\n flag.\n \n Dynamic library stub function\n \n Flags:\n - clutch : c (unicode) [create]\n Only delete command attachments with this clutch.\n \n - device : d (unicode) [create]\n Specifies the device to work on. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.unassignInputDevice`\n '
pass<|docstring|>This command deletes all command strings associated with this device. In query mode, return type is based on queried
flag.
Dynamic library stub function
Flags:
- clutch : c (unicode) [create]
Only delete command attachments with this clutch.
- device : d (unicode) [create]
Specifies the device to work on. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.unassignInputDevice`<|endoftext|>
|
075c0991beafb0ce629db425099531be18b54c45b9d1e589cc690ea6a8d07914
|
def dgtimer(*args, **kwargs):
"\n This command measures dependency graph node performance by managing timers on a per-node basis. Logically, each DG node\n has a timer associated with it which records the amount of real time spent in various operations on its plugs. The time\n measurement includes the cost of copying data to the node on behalf of the operation, MEL commands executed by an\n expression contained in an expression invoked by the node, and includes any wait time such as when a fileTexture node\n loads an image file from disk. Most DG operations are reported including compute, draw, and dirty propagation. The\n various operations we measure are called metricsand the types of timers are called timer types. The various metrics are\n always measured when timing is on, but are only queried when specified via the -show and -hide flags. The metrics\n currently supported are listed in detail under the -show flag below. For each metric we support a standard set of timer\n types. There are three of these: selffor self time (the time specific to the node and not its children), inclusive(time\n including children of the node), and count(number of operations of the given metric on the node). The timing mechanism\n which is used by dgtimeris built into the DG itself, thus ALL depend nodes can be timed and there is no need for\n programmers writing plug-ins using the OpenMaya API to add any special code in order for their nodes to be timed -- its\n all handled transparently. The dgtimercommand allows node timers to be turned on, off, reset to zero, and have their\n current value displayed, and these operations can be performed globally on all nodes or on a specific set of nodes\n defined by name, type or parentage. Note that all timer measurements are computed in real time(the same time measurement\n you get from a wristwatch) as opposed to CPU time(which only measures time when the processor is executing your code).\n All times are displayed in seconds. Use the -query flag to display the current timer values on a node, use -on to turn\n on timing, use -off to turn off timing, and -reset to reset timers to zero. To display the values measured during\n timing, there are two approaches. The first method is to use the -query flag can be used to report the information which\n has been measured. The second method is to use the query methods available on the OpenMaya class MFnDependencyNode (see\n the OpenMaya documentation for details). What follows is a description of what is generated via -query. The output is\n broken out into several sections and these are described as follows: SECTION 1:Section 1 of the dgtimer output contains\n global information. This section can be disabled via the -hoHeader flag. These values are reset whenever a global timer\n reset occurs (i.e. dgtimer -reset;is specified). The global values which are reported are: Total real time:the total\n wall-clock time since the last global timer reset. This is the actual time which has been spent as you might measure it\n measure it with your watch. On a multi-processing system, this value will always remain true to to real time (unlike\n userand systime).Total user time:the total time the CPU(s) spent processing Maya not including any system time since the\n last global timer reset.Total sys time:the total time the CPU(s) spent in operating system calls on behalf of Maya since\n the last global timer reset. Summary of each metric for all nodes:a summary of self and count for each metric that we\n measure:Real time in callbacksreports the self time and count for the callbackmetric.Real time in computereports the\n self time and count for the computemetric.Real time in dirty propagationreports the self time and count for the\n dirtymetric.Real time in drawingreports the self time and count for the drawmetric.Real time fetching data from\n plugsreports the self time and count for the fetchmetric.Breakdown of select metrics in greater detail:a reporting of\n certain combinations of metrics that we measure:Real time in compute invoked from callbackreports the self time spent in\n compute when invoked either directly or indirectly by a callback.Real time in compute not invoked from callbackreports\n the self time spent in compute not invoked either directly or indirectly by a callback.SECTION 2:Section 2 of the\n dgtimer -query output contains per-node information. There is a header which describes the meaning of each column,\n followed by the actual per-node data, and this is ultimately followed by a footer which summarises the totals per\n column. Note that the data contained in the footer is the global total for each metric and will include any nodes that\n have been deleted since the last reset, so the value in the footer MAY exceed what you get when you total the individual\n values in the column. To prevent the header and footer from appearing, use the -noHeader flag to just display the per-\n node data. The columns which are displayed are as follows: Rank:The order of this node in the sorted list of all nodes,\n where the list is sorted by -sortMetric and -sortType flag values (if these are omitted the default is to sort by self\n compute time).ON:Tells you if the timer for that node is currently on or off. (With dgtimer, you have the ability to\n turn timing on and off on a per-node basis).Per-metric information:various columns are reported for each metric. The\n name of the metric is reported at in the header in capital letters (e.g. DRAW). The standard columns for each metric\n are:Self:The amount of real time (i.e. elapsed time as you might measure it with a stopwatch) spent performing the\n operation (thus if the metric is DRAW, then this will be time spent drawing the node).Inclusive:The amount of real time\n (i.e. elapsed time as you might measure it with a stopwatch) spent performing the operation including any child\n operations that were invoked on behalf of the operation (thus if the metric is DRAW, then this will be the total time\n taken to draw the node including any child operations).Count:The number of operations that occued on this node (thus if\n the metric is DRAW, then the number of draw operations on the node will be reported).Sort informationif a column is the\n one being used to sort all the per-node dgtimer information, then that column is followed by a Percentand\n Cumulativecolumn which describe a running total through the listing. Note that -sortType noneprevents these two columns\n from appearing and implicitely sorts on selftime.After the per-metric columns, the node name and type are\n reported:TypeThe node type.NameThe name of the node. If the node is file referenced and you are using namespaces, the\n namespace will be included. You can also force the dagpath to be displayed by specifying the -uniqueName flag.Plug-in\n nameIf the node was implemented in an OpenMaya plug-in, the name of that plug-in is reported.SECTION 3:Section 3 of the\n dgtimer -query output describes time spent in callbacks. Note that section 3 only appears when the CALLBACK metric is\n shown (see the -show flag). The first part is SECTION 3.1 lists the time per callback with each entry comprising: The\n name of the callback, such as attributeChangedMsg. These names are internal Maya names, and in the cases where the\n callback is available through the OpenMaya API, the API access to the callback is similarly named.The name is followed\n by a breakdown per callbackId. The callbackId is an identifying number which is unique to each client that is registered\n to a callback and can be deduced by the user, such as through the OpenMaya API. You can cross-reference by finding the\n same callbackId value listed in SECTIONs 3.1 and 3.3.Self time (i.e. real time spent within that callbackId type not\n including any child operations which occur while processing the callback).Percent (see the -sortType flag). Note that\n the percent values are listed to sum up to 100% for that callback. This is not a global percent.Cumulative (see the\n -sortType flag).Inclusive time (i.e. real time spent within that callbackId including any child operations).Count\n (number of times the callbackId was invoked).API lists Yif the callbackId was defined through the OpenMaya API, and Nif\n the callbackId was defined internally within Maya.Node lists the name of the node this callbackId was associated with.\n If the callbackId was associated with more than one node, the string \\*multiple\\*is printed. If there was no node\n associated with the callbackId (or its a callback type in which the node is hard to deduce), the entry is blank.After\n the callbackId entries are listed, a dashed line is printed followed by a single line listing the self, inclusive and\n count values for the callback. Note that the percent is relative to the global callback time.At the bottom of SECTION\n 3.1 is the per-column total. The values printed match the summation at the bottom of the listing in section 2. Note that\n the values from SECTION 3.1 include any nodes that have been deleted since the last reset. The thresholding parameters\n (-threshold, -rangeLower, -rangeUpper and -maxDisplay) are honoured when generating the listing. The sorting of the rows\n and display of the Percent and Cumulative columns obeys the -sortType flag. As the listing can be long, zero entries are\n not displayed. The second part is SECTION 3.2 which lists the data per callbackId. As noted earlier, the callbackId is\n an identifying number which is unique to each client that is registered to a callback and can be deduced by the user,\n such as through the OpenMaya API. The entries in SECTION 3.2 appear as follows: CallbackId the numeric identifier for\n the callback. You can cross reference by finding the same callbackId value listed in SECTIONs 3.1 and 3.3.For each\n callbackId, the data is broken down per-callback:Callback the name of the callback, e.g. attributeChangedMsg.Percent,\n Cumulative, Inclusive, Count, API and Node entries as described in SECTION 3.1.After the callback entries are listed for\n the callbackId, a dashed followed by a summary line is printed. The summary line lists the self, inclusive and count\n values for the callback. Note that the percent is relative to the global callback time.The third part is SECTION 3.3\n which lists data per-callback per-node. The nodes are sorted based on the -sortType flag, and for each node, the\n callbacks are listed, also sorted based on the -sortType flag. As this listing can be long, zero entries are not\n displayed. An important note for SECTION 3.3 is that only nodes which still exist are displayed. If a node has been\n deleted, no infromation is listed.\n \n Flags:\n - combineType : ct (bool) [query]\n Causes all nodes of the same type (e.g. animCurveTA) to be combined in the output display.\n \n - hide : hi (unicode) [create,query]\n This flag is the converse of -show. As with -show, it is a query-only flag which can be specified multiple times. If you\n do specify -hide, we display all columns except those listed by the -hide flags.\n \n - hierarchy : h (bool) [create,query]\n Used to specify that a hierarchy of the dependency graph be affected, thus -reset -hierarchy -name ballwill reset the\n timers on the node named balland all of its descendents in the dependency graph.\n \n - maxDisplay : m (int) [query]\n Truncates the display so that only the most expenive nentries are printed in the output display.\n \n - name : n (unicode) [create,query]\n Used in conjunction with -reset or -query to specify the name of the node to reset or print timer values for. When\n querying a single timer, only a single line of output is generated (i.e. the global timers and header information is\n omitted). Note that one can force output to the script editor window via the -outputFile MELoption to make it easy to\n grab the values in a MEL script. Note: the -name and -type flag cannot be used together.\n \n - noHeader : nh (bool) [create,query]\n Used in conjunction with -query to prevent any header or footer information from being printed. All that will be output\n is the per-node timing data. This option makes it easier to parse the output such as when you output the query to a file\n on disk using the -outputFileoption.\n \n - outputFile : o (unicode) [query]\n Specifies where the output of timing or tracing is displayed. The flag takes a string argument which accepts three\n possible values: The name of a file on disk.Or the keyword stdout, which causes output to be displayed on the terminal\n window (Linux and Macintosh), and the status window on Windows.Or the keyword MEL, which causes output to be displayed\n in the Maya Script Editor (only supported with -query).The stdoutsetting is the default behaviour. This flag can be used\n with the -query flag as well as the -trace flag. When used with the -trace flag, any tracing output will be displayed on\n the destination specified by the -outputFile (or stdout if -outputFile is omitted). Tracing operations will continue to\n output to the destination until you specify the -trace and -outputFile flags again. When used with the -query flag,\n timing output will be displayed to the destination specified by the -outputFile (or stdoutif -outputFile is omitted).\n Here are some examples of how to use the -query, -trace and -outputFile flags: Example: output the timing information to\n a single file on disk:dgtimer -on; // Turn on timing create some animated scene\n content; play -wait; // Play the scene through dgtimer -query -outputFile\n /tmp/timing.txt// Output node timing information to a file on disk Example: output the tracing information to a single\n file on disk:dgtimer -on; // Turn on timing create some animated scene content;\n dgtimer -trace on -outputFile /tmp/trace.txt// Turn on tracing and output the results to file play -wait;\n // Play the scene through; trace info goes to /tmp/trace.txt dgtimer -query; // But\n the timing info goes to the terminal window play -wait; // Play the scene again,\n trace info still goes to /tmp/trace.txt Example: two runs, outputting the trace information and timing information to\n separate files:dgtimer -on; // Turn on timing create some animated scene content;\n dgtimer -trace on -outputFile /tmp/trace1.txt// Turn on tracing and output the results to file play -wait;\n // Play the scene through dgtimer -query -outputFile /tmp/query1.txt// Output node timing information to another file\n dgtimer -reset; dgtimer -trace on -outputFile /tmp/trace2.txt// Output tracing results to different file play -wait;\n // Play the scene through dgtimer -query -outputFile /tmp/query2.txt// Output node timing information to another file\n Tips and tricks:Outputting the timing results to the script editor makes it easy to use the results in MEL e.g. string\n $timing[] = `dgtimer -query -outputFile MEL`.It is important to note that the -outputFile you specify with -trace is\n totally independent from the one you specify with -query.If the file you specify already exists, Maya will empty the\n file first before outputting data to it (and if the file is not writable, an error is generated instead).\n \n - overhead : oh (bool) [create,query]\n Turns on and off the measurement of timing overhead. Under ordinary circumstances the amount of timing overhead is\n minimal compared with the events being measured, but in complex scenes, one might find the overhead to be measurable. By\n default this option is turned off. To enable it, specify dgtimer -overhead trueprior to starting timing. When querying\n timing, the overhead is reported in SECTION 1.2 of the dgtimer output and is not factored out of each individual\n operation.\n \n - rangeLower : rgl (float) [create]\n This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map\n with -updateHeatMap. The value is the lower percentage cutoff for the nodes which are processed. There is also a\n -rangeLower flag which sets the lower range limit. The default value is 0, meaning that all nodes with timing value\n below the upper range limit are considered.\n \n - rangeUpper : rgu (float) [create]\n This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map\n with -updateHeatMap. The value is the upper percentage cutoff for the nodes which are processed. There is also a\n -rangeLower flag which sets the lower range limit. The default value is 100, meaning that all nodes with timing value\n above the lower range limit are considered.\n \n - reset : r (bool) [create]\n Resets the node timers to zero. By default, the timers on all nodes as well as the global timers are reset, but if\n specified with the -name or -type flags, only the timers on specified nodes are reset.\n \n - returnCode : rc (unicode) [create,query]\n This flag has been replaced by the more general -returnType flag. The -returnCode flag was unfortunately specific to the\n compute metric only. It exists only for backwards compatability purposes. It will be removed altogether in a future\n release. Here are some handy equivalences: To get the total number of nodes:OLD WAY: dgtimer -rc nodecount -q;//\n Result:325//NEW WAY: dgtimer -returnType total -sortType none -q;// Result:325//OLD WAY: dgtimer -rc count -q;//\n Result:1270//To get the sum of the compute count column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType\n count -q;// Result:1270//OLD WAY: dgtimer -rc selftime -q;// Result:0.112898//To get the sum of the compute self\n column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType self -q;// Result:0.112898//\n \n - returnType : rt (unicode) [query]\n This flag specifies what the double value returned by the dgtimer command represents. By default, the value returned is\n the global total as displayed in SECTION 1 for the column we are sorting on in the per-node output (the sort column can\n be specified via the -sortMetric and -sortType flags). However, instead of the total being returned, the user can\n instead request the individual entries for the column. This flag is useful mainly for querying without forcing any\n output. The flag accepts the values total, to just display the column total, or allto display all entries individually.\n For example, if you want to get the total of draw self time without any other output simply specify the following:\n dgtimer -returnType total -sortMetric draw -sortType self -threshold 100 -noHeader -query;// Result: 7718.01 // To\n instead get each individual entry, change the above query to: dgtimer -returnType all -sortMetric draw -sortType self\n -threshold 100 -noHeader -query;// Result: 6576.01 21.91 11.17 1108.92 // To get the inclusive dirty time for a specific\n node, use -name as well as -returnType all: dgtimer -name virginia-returnType all -sortMetric dirty -sortType inclusive\n -threshold 100 -noHeader -query;Note: to get the total number of nodes, use -sortType none -returnType total. To get\n the on/off status for each node, use -sortType none -returnType all.\n \n - show : sh (unicode) [create,query]\n Used in conjunction with -query to specify which columns are to be displayed in the per-node section of the output.\n -show takes an argument, which can be all(to display all columns), callback(to display the time spent during any\n callback processing on the node not due to evaluation), compute(to display the time spent in the node's compute\n methods), dirty(to display time spent propagating dirtiness on behalf of the node), draw(to display time spent drawing\n the node), compcb(to display time spent during callback processing on node due to compute), and compncb(to display time\n spent during callback processing on node NOT due to compute). The -show flag can be used multiple times, but cannot be\n specified with -hide. By default, if neither -show, -hide, or -sort are given, the effective display mode is: dgtimer\n -show compute -query.\n \n - sortMetric : sm (unicode) [create,query]\n Used in conjunction with -query to specify which metric is to be sorted on when the per-node section of the output is\n generated, for example drawtime. Note that the -sortType flag can also be specified to define which timer is sorted on:\n for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was\n drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortMetric flag can\n only be specified at most once. The flag takes the following arguments: callback(to sort on time spent during any\n callback processing on the node), compute(to sort on the time spent in the node's compute methods), dirty(to sort on the\n time spent propagating dirtiness on behalf of the node), draw(to sort on time spent drawing the node), fetch(to sort on\n time spent copying data from the datablock), The default, if -sortMetric is omitted, is to sort on the first displayed\n column. Note that the sortMetric is independent of which columns are displayed via -show and -hide. Sort on a hidden\n column is allowed. The column selected by -sortMetric and -sortType specifies which total is returned by the dgtimer\n command on the MEL command line. This flag is also used with -updateHeatMap to specify which metric to build the heat\n map for.\n \n - sortType : st (unicode) [create,query]\n Used in conjunction with -query to specify which timer is to be sorted on when the per-node section of the output is\n generated, for example selftime. Note that the -sortMetric flag can also be specified to define which metric is sorted\n on: for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was\n drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortType flag can be\n specified at most once. The flag takes the following arguments: self(to sort on self time, which is the time specific to\n the node and not its children), inclusive(to sort on the time including children of the node), count(to sort on the\n number of times the node was invoked). and none(to sort on self time, but do not display the Percent and Cumulative\n columns in the per-node display, as well as cause the total number of nodes in Maya to be returned on the command line).\n The default, if -sortType is omitted, is to sort on self time. The column selected by -sortMetric and -sortType\n specifies which total is returned by the dgtimer command on the MEL command line. The global total as displayed in\n SECTION 1 of the listing is returned. The special case of -sortType nonecauses the number of nodes in Maya to instead be\n returned. This flag is also used with -updateHeatMap to specify which metric to build the heat map for.\n \n - threshold : th (float) [query]\n Truncates the display once the value falls below the threshold value. The threshold applies to whatever timer is being\n used for sorting. For example, if our sort key is self compute time (i.e. -sortMetric is computeand -sortType is self)\n and the threshold parameter is 20.0, then only nodes with a compute self-time of 20.0 or higher will be displayed. (Note\n that -threshold uses absolute time. There are the similar -rangeUpper and -rangeLower parameters which specify a range\n using percentage).\n \n - timerOff : off (bool) [create,query]\n Turns off node timing. By default, the timers on all nodes are turned off, but if specified with the -name or -type\n flags, only the timers on specified nodes are turned off. If the timers on all nodes become turned off, then global\n timing is also turned off as well.\n \n - timerOn : on (bool) [create,query]\n Turns on node timing. By default, the timers on all nodes are turned on, but if specified with the -name or -type flags,\n only the timers on specified nodes are turned on. The global timers are also turned on by this command. Note that\n turning on timing does NOT reset the timers to zero. Use the -reset flag to reset the timers. The idea for NOT resetting\n the timers is to allow the user to arbitrarily turn timing on and off and continue to add to the existing timer values.\n \n - trace : tr (bool) [create]\n Turns on or off detailed execution tracing. By default, tracing is off. If enabled, each timeable operation is logged\n when it starts and again when it ends. This flag can be used in conjunction with -outputFile to specify where the output\n is generated to. The following example shows how the output is formatted:dgtimer:begin: compute 3 particleShape1Deformed\n particleShape1Deformed.lastPosition The above is an example of the output when -trace is true that marks the start of an\n operation. For specific details on each field: the dgtimer:begin:string is an identifying marker to flag that this is a\n begin operation record. The second argument, computein our example, is the operation metric. You can view the output of\n each given metric via dgtimer -qby specifying the -show flag. The integer which follows (3 in this case) is the depth in\n the operation stack, and the third argument is the name of the node (particleShape1Deformed). The fourth argument is\n specific to the metric. For compute, it gives the name of the plug being computed. For callback, its the internal Maya\n name of the callback. For dirty, its the name of the plug that dirtiness is being propagated from.dgtimer:end: compute 3\n particleShape1Deformed 0.000305685 0.000305685 The above is the end operation record. The compute, 3and\n particleShapeDeformedarguments were described in the dgtimer:beginoverview earlier. The two floating-point arguments are\n self time and inclusive time for the operation measured in seconds. The inclusive measure lists the total time since the\n matching dgtimer:begin:entry for this operation, while the self measure lists the inclusive time minus any time consumed\n by child operations which may have occurred during execution of the current operation. As noted elsewhere in this\n document, these two times are wall clock times, measuring elapsed time including any time in which Maya was idle or\n performing system calls. Since dgtimer can measure some non-node qualities in Maya, such as global message callbacks, a\n -is displayed where the node name would ordinarily be displayed. The -means not applicable.\n \n - type : t (unicode) [create,query]\n Used in conjunction with -reset or -query to specify the type of the node(s) (e.g. animCurveTA) to reset or print timer\n values for. When querying, use of the -combineType flag will cause all nodes of the same type to be combined into one\n entry, and only one line of output is generated (i.e. the global timers and header information is omitted). Note: the\n -name and -type flag cannot be used together.\n \n - uniqueName : un (bool) [create,query]\n Used to specify that the DAG nodes listed in the output should be listed by their unique names. The full DAG path to\n the object will be printed out instead of just the node name.\n \n - updateHeatMap : uhm (int) [create]\n Forces Maya's heat map to rebuild based on the specified parameters. The heat map is an internal dgtimer structure used\n in mapping intensity values to colourmap entries during display by the HyperGraph Editor. There is one heat map shared\n by all editors that are using heat map display mode. Updating the heat map causes the timer values on all nodes to be\n analysed to compose the distribution of entries in the heat map. The parameter is the integer number of divisions in the\n map and should equal the number of available colours for displaying the heat map. This flag can be specified with the\n -rangeLower and -rangeUpper flags to limit the range of displayable to lie between the percentile range. The dgtimer\n command returns the maximum timing value for all nodes in Maya for the specified metric and type. Note: when the display\n range includes 0, the special zeroth (exactly zero) slot in the heat map is avilable.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgtimer`\n "
pass
|
This command measures dependency graph node performance by managing timers on a per-node basis. Logically, each DG node
has a timer associated with it which records the amount of real time spent in various operations on its plugs. The time
measurement includes the cost of copying data to the node on behalf of the operation, MEL commands executed by an
expression contained in an expression invoked by the node, and includes any wait time such as when a fileTexture node
loads an image file from disk. Most DG operations are reported including compute, draw, and dirty propagation. The
various operations we measure are called metricsand the types of timers are called timer types. The various metrics are
always measured when timing is on, but are only queried when specified via the -show and -hide flags. The metrics
currently supported are listed in detail under the -show flag below. For each metric we support a standard set of timer
types. There are three of these: selffor self time (the time specific to the node and not its children), inclusive(time
including children of the node), and count(number of operations of the given metric on the node). The timing mechanism
which is used by dgtimeris built into the DG itself, thus ALL depend nodes can be timed and there is no need for
programmers writing plug-ins using the OpenMaya API to add any special code in order for their nodes to be timed -- its
all handled transparently. The dgtimercommand allows node timers to be turned on, off, reset to zero, and have their
current value displayed, and these operations can be performed globally on all nodes or on a specific set of nodes
defined by name, type or parentage. Note that all timer measurements are computed in real time(the same time measurement
you get from a wristwatch) as opposed to CPU time(which only measures time when the processor is executing your code).
All times are displayed in seconds. Use the -query flag to display the current timer values on a node, use -on to turn
on timing, use -off to turn off timing, and -reset to reset timers to zero. To display the values measured during
timing, there are two approaches. The first method is to use the -query flag can be used to report the information which
has been measured. The second method is to use the query methods available on the OpenMaya class MFnDependencyNode (see
the OpenMaya documentation for details). What follows is a description of what is generated via -query. The output is
broken out into several sections and these are described as follows: SECTION 1:Section 1 of the dgtimer output contains
global information. This section can be disabled via the -hoHeader flag. These values are reset whenever a global timer
reset occurs (i.e. dgtimer -reset;is specified). The global values which are reported are: Total real time:the total
wall-clock time since the last global timer reset. This is the actual time which has been spent as you might measure it
measure it with your watch. On a multi-processing system, this value will always remain true to to real time (unlike
userand systime).Total user time:the total time the CPU(s) spent processing Maya not including any system time since the
last global timer reset.Total sys time:the total time the CPU(s) spent in operating system calls on behalf of Maya since
the last global timer reset. Summary of each metric for all nodes:a summary of self and count for each metric that we
measure:Real time in callbacksreports the self time and count for the callbackmetric.Real time in computereports the
self time and count for the computemetric.Real time in dirty propagationreports the self time and count for the
dirtymetric.Real time in drawingreports the self time and count for the drawmetric.Real time fetching data from
plugsreports the self time and count for the fetchmetric.Breakdown of select metrics in greater detail:a reporting of
certain combinations of metrics that we measure:Real time in compute invoked from callbackreports the self time spent in
compute when invoked either directly or indirectly by a callback.Real time in compute not invoked from callbackreports
the self time spent in compute not invoked either directly or indirectly by a callback.SECTION 2:Section 2 of the
dgtimer -query output contains per-node information. There is a header which describes the meaning of each column,
followed by the actual per-node data, and this is ultimately followed by a footer which summarises the totals per
column. Note that the data contained in the footer is the global total for each metric and will include any nodes that
have been deleted since the last reset, so the value in the footer MAY exceed what you get when you total the individual
values in the column. To prevent the header and footer from appearing, use the -noHeader flag to just display the per-
node data. The columns which are displayed are as follows: Rank:The order of this node in the sorted list of all nodes,
where the list is sorted by -sortMetric and -sortType flag values (if these are omitted the default is to sort by self
compute time).ON:Tells you if the timer for that node is currently on or off. (With dgtimer, you have the ability to
turn timing on and off on a per-node basis).Per-metric information:various columns are reported for each metric. The
name of the metric is reported at in the header in capital letters (e.g. DRAW). The standard columns for each metric
are:Self:The amount of real time (i.e. elapsed time as you might measure it with a stopwatch) spent performing the
operation (thus if the metric is DRAW, then this will be time spent drawing the node).Inclusive:The amount of real time
(i.e. elapsed time as you might measure it with a stopwatch) spent performing the operation including any child
operations that were invoked on behalf of the operation (thus if the metric is DRAW, then this will be the total time
taken to draw the node including any child operations).Count:The number of operations that occued on this node (thus if
the metric is DRAW, then the number of draw operations on the node will be reported).Sort informationif a column is the
one being used to sort all the per-node dgtimer information, then that column is followed by a Percentand
Cumulativecolumn which describe a running total through the listing. Note that -sortType noneprevents these two columns
from appearing and implicitely sorts on selftime.After the per-metric columns, the node name and type are
reported:TypeThe node type.NameThe name of the node. If the node is file referenced and you are using namespaces, the
namespace will be included. You can also force the dagpath to be displayed by specifying the -uniqueName flag.Plug-in
nameIf the node was implemented in an OpenMaya plug-in, the name of that plug-in is reported.SECTION 3:Section 3 of the
dgtimer -query output describes time spent in callbacks. Note that section 3 only appears when the CALLBACK metric is
shown (see the -show flag). The first part is SECTION 3.1 lists the time per callback with each entry comprising: The
name of the callback, such as attributeChangedMsg. These names are internal Maya names, and in the cases where the
callback is available through the OpenMaya API, the API access to the callback is similarly named.The name is followed
by a breakdown per callbackId. The callbackId is an identifying number which is unique to each client that is registered
to a callback and can be deduced by the user, such as through the OpenMaya API. You can cross-reference by finding the
same callbackId value listed in SECTIONs 3.1 and 3.3.Self time (i.e. real time spent within that callbackId type not
including any child operations which occur while processing the callback).Percent (see the -sortType flag). Note that
the percent values are listed to sum up to 100% for that callback. This is not a global percent.Cumulative (see the
-sortType flag).Inclusive time (i.e. real time spent within that callbackId including any child operations).Count
(number of times the callbackId was invoked).API lists Yif the callbackId was defined through the OpenMaya API, and Nif
the callbackId was defined internally within Maya.Node lists the name of the node this callbackId was associated with.
If the callbackId was associated with more than one node, the string \*multiple\*is printed. If there was no node
associated with the callbackId (or its a callback type in which the node is hard to deduce), the entry is blank.After
the callbackId entries are listed, a dashed line is printed followed by a single line listing the self, inclusive and
count values for the callback. Note that the percent is relative to the global callback time.At the bottom of SECTION
3.1 is the per-column total. The values printed match the summation at the bottom of the listing in section 2. Note that
the values from SECTION 3.1 include any nodes that have been deleted since the last reset. The thresholding parameters
(-threshold, -rangeLower, -rangeUpper and -maxDisplay) are honoured when generating the listing. The sorting of the rows
and display of the Percent and Cumulative columns obeys the -sortType flag. As the listing can be long, zero entries are
not displayed. The second part is SECTION 3.2 which lists the data per callbackId. As noted earlier, the callbackId is
an identifying number which is unique to each client that is registered to a callback and can be deduced by the user,
such as through the OpenMaya API. The entries in SECTION 3.2 appear as follows: CallbackId the numeric identifier for
the callback. You can cross reference by finding the same callbackId value listed in SECTIONs 3.1 and 3.3.For each
callbackId, the data is broken down per-callback:Callback the name of the callback, e.g. attributeChangedMsg.Percent,
Cumulative, Inclusive, Count, API and Node entries as described in SECTION 3.1.After the callback entries are listed for
the callbackId, a dashed followed by a summary line is printed. The summary line lists the self, inclusive and count
values for the callback. Note that the percent is relative to the global callback time.The third part is SECTION 3.3
which lists data per-callback per-node. The nodes are sorted based on the -sortType flag, and for each node, the
callbacks are listed, also sorted based on the -sortType flag. As this listing can be long, zero entries are not
displayed. An important note for SECTION 3.3 is that only nodes which still exist are displayed. If a node has been
deleted, no infromation is listed.
Flags:
- combineType : ct (bool) [query]
Causes all nodes of the same type (e.g. animCurveTA) to be combined in the output display.
- hide : hi (unicode) [create,query]
This flag is the converse of -show. As with -show, it is a query-only flag which can be specified multiple times. If you
do specify -hide, we display all columns except those listed by the -hide flags.
- hierarchy : h (bool) [create,query]
Used to specify that a hierarchy of the dependency graph be affected, thus -reset -hierarchy -name ballwill reset the
timers on the node named balland all of its descendents in the dependency graph.
- maxDisplay : m (int) [query]
Truncates the display so that only the most expenive nentries are printed in the output display.
- name : n (unicode) [create,query]
Used in conjunction with -reset or -query to specify the name of the node to reset or print timer values for. When
querying a single timer, only a single line of output is generated (i.e. the global timers and header information is
omitted). Note that one can force output to the script editor window via the -outputFile MELoption to make it easy to
grab the values in a MEL script. Note: the -name and -type flag cannot be used together.
- noHeader : nh (bool) [create,query]
Used in conjunction with -query to prevent any header or footer information from being printed. All that will be output
is the per-node timing data. This option makes it easier to parse the output such as when you output the query to a file
on disk using the -outputFileoption.
- outputFile : o (unicode) [query]
Specifies where the output of timing or tracing is displayed. The flag takes a string argument which accepts three
possible values: The name of a file on disk.Or the keyword stdout, which causes output to be displayed on the terminal
window (Linux and Macintosh), and the status window on Windows.Or the keyword MEL, which causes output to be displayed
in the Maya Script Editor (only supported with -query).The stdoutsetting is the default behaviour. This flag can be used
with the -query flag as well as the -trace flag. When used with the -trace flag, any tracing output will be displayed on
the destination specified by the -outputFile (or stdout if -outputFile is omitted). Tracing operations will continue to
output to the destination until you specify the -trace and -outputFile flags again. When used with the -query flag,
timing output will be displayed to the destination specified by the -outputFile (or stdoutif -outputFile is omitted).
Here are some examples of how to use the -query, -trace and -outputFile flags: Example: output the timing information to
a single file on disk:dgtimer -on; // Turn on timing create some animated scene
content; play -wait; // Play the scene through dgtimer -query -outputFile
/tmp/timing.txt// Output node timing information to a file on disk Example: output the tracing information to a single
file on disk:dgtimer -on; // Turn on timing create some animated scene content;
dgtimer -trace on -outputFile /tmp/trace.txt// Turn on tracing and output the results to file play -wait;
// Play the scene through; trace info goes to /tmp/trace.txt dgtimer -query; // But
the timing info goes to the terminal window play -wait; // Play the scene again,
trace info still goes to /tmp/trace.txt Example: two runs, outputting the trace information and timing information to
separate files:dgtimer -on; // Turn on timing create some animated scene content;
dgtimer -trace on -outputFile /tmp/trace1.txt// Turn on tracing and output the results to file play -wait;
// Play the scene through dgtimer -query -outputFile /tmp/query1.txt// Output node timing information to another file
dgtimer -reset; dgtimer -trace on -outputFile /tmp/trace2.txt// Output tracing results to different file play -wait;
// Play the scene through dgtimer -query -outputFile /tmp/query2.txt// Output node timing information to another file
Tips and tricks:Outputting the timing results to the script editor makes it easy to use the results in MEL e.g. string
$timing[] = `dgtimer -query -outputFile MEL`.It is important to note that the -outputFile you specify with -trace is
totally independent from the one you specify with -query.If the file you specify already exists, Maya will empty the
file first before outputting data to it (and if the file is not writable, an error is generated instead).
- overhead : oh (bool) [create,query]
Turns on and off the measurement of timing overhead. Under ordinary circumstances the amount of timing overhead is
minimal compared with the events being measured, but in complex scenes, one might find the overhead to be measurable. By
default this option is turned off. To enable it, specify dgtimer -overhead trueprior to starting timing. When querying
timing, the overhead is reported in SECTION 1.2 of the dgtimer output and is not factored out of each individual
operation.
- rangeLower : rgl (float) [create]
This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map
with -updateHeatMap. The value is the lower percentage cutoff for the nodes which are processed. There is also a
-rangeLower flag which sets the lower range limit. The default value is 0, meaning that all nodes with timing value
below the upper range limit are considered.
- rangeUpper : rgu (float) [create]
This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map
with -updateHeatMap. The value is the upper percentage cutoff for the nodes which are processed. There is also a
-rangeLower flag which sets the lower range limit. The default value is 100, meaning that all nodes with timing value
above the lower range limit are considered.
- reset : r (bool) [create]
Resets the node timers to zero. By default, the timers on all nodes as well as the global timers are reset, but if
specified with the -name or -type flags, only the timers on specified nodes are reset.
- returnCode : rc (unicode) [create,query]
This flag has been replaced by the more general -returnType flag. The -returnCode flag was unfortunately specific to the
compute metric only. It exists only for backwards compatability purposes. It will be removed altogether in a future
release. Here are some handy equivalences: To get the total number of nodes:OLD WAY: dgtimer -rc nodecount -q;//
Result:325//NEW WAY: dgtimer -returnType total -sortType none -q;// Result:325//OLD WAY: dgtimer -rc count -q;//
Result:1270//To get the sum of the compute count column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType
count -q;// Result:1270//OLD WAY: dgtimer -rc selftime -q;// Result:0.112898//To get the sum of the compute self
column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType self -q;// Result:0.112898//
- returnType : rt (unicode) [query]
This flag specifies what the double value returned by the dgtimer command represents. By default, the value returned is
the global total as displayed in SECTION 1 for the column we are sorting on in the per-node output (the sort column can
be specified via the -sortMetric and -sortType flags). However, instead of the total being returned, the user can
instead request the individual entries for the column. This flag is useful mainly for querying without forcing any
output. The flag accepts the values total, to just display the column total, or allto display all entries individually.
For example, if you want to get the total of draw self time without any other output simply specify the following:
dgtimer -returnType total -sortMetric draw -sortType self -threshold 100 -noHeader -query;// Result: 7718.01 // To
instead get each individual entry, change the above query to: dgtimer -returnType all -sortMetric draw -sortType self
-threshold 100 -noHeader -query;// Result: 6576.01 21.91 11.17 1108.92 // To get the inclusive dirty time for a specific
node, use -name as well as -returnType all: dgtimer -name virginia-returnType all -sortMetric dirty -sortType inclusive
-threshold 100 -noHeader -query;Note: to get the total number of nodes, use -sortType none -returnType total. To get
the on/off status for each node, use -sortType none -returnType all.
- show : sh (unicode) [create,query]
Used in conjunction with -query to specify which columns are to be displayed in the per-node section of the output.
-show takes an argument, which can be all(to display all columns), callback(to display the time spent during any
callback processing on the node not due to evaluation), compute(to display the time spent in the node's compute
methods), dirty(to display time spent propagating dirtiness on behalf of the node), draw(to display time spent drawing
the node), compcb(to display time spent during callback processing on node due to compute), and compncb(to display time
spent during callback processing on node NOT due to compute). The -show flag can be used multiple times, but cannot be
specified with -hide. By default, if neither -show, -hide, or -sort are given, the effective display mode is: dgtimer
-show compute -query.
- sortMetric : sm (unicode) [create,query]
Used in conjunction with -query to specify which metric is to be sorted on when the per-node section of the output is
generated, for example drawtime. Note that the -sortType flag can also be specified to define which timer is sorted on:
for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was
drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortMetric flag can
only be specified at most once. The flag takes the following arguments: callback(to sort on time spent during any
callback processing on the node), compute(to sort on the time spent in the node's compute methods), dirty(to sort on the
time spent propagating dirtiness on behalf of the node), draw(to sort on time spent drawing the node), fetch(to sort on
time spent copying data from the datablock), The default, if -sortMetric is omitted, is to sort on the first displayed
column. Note that the sortMetric is independent of which columns are displayed via -show and -hide. Sort on a hidden
column is allowed. The column selected by -sortMetric and -sortType specifies which total is returned by the dgtimer
command on the MEL command line. This flag is also used with -updateHeatMap to specify which metric to build the heat
map for.
- sortType : st (unicode) [create,query]
Used in conjunction with -query to specify which timer is to be sorted on when the per-node section of the output is
generated, for example selftime. Note that the -sortMetric flag can also be specified to define which metric is sorted
on: for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was
drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortType flag can be
specified at most once. The flag takes the following arguments: self(to sort on self time, which is the time specific to
the node and not its children), inclusive(to sort on the time including children of the node), count(to sort on the
number of times the node was invoked). and none(to sort on self time, but do not display the Percent and Cumulative
columns in the per-node display, as well as cause the total number of nodes in Maya to be returned on the command line).
The default, if -sortType is omitted, is to sort on self time. The column selected by -sortMetric and -sortType
specifies which total is returned by the dgtimer command on the MEL command line. The global total as displayed in
SECTION 1 of the listing is returned. The special case of -sortType nonecauses the number of nodes in Maya to instead be
returned. This flag is also used with -updateHeatMap to specify which metric to build the heat map for.
- threshold : th (float) [query]
Truncates the display once the value falls below the threshold value. The threshold applies to whatever timer is being
used for sorting. For example, if our sort key is self compute time (i.e. -sortMetric is computeand -sortType is self)
and the threshold parameter is 20.0, then only nodes with a compute self-time of 20.0 or higher will be displayed. (Note
that -threshold uses absolute time. There are the similar -rangeUpper and -rangeLower parameters which specify a range
using percentage).
- timerOff : off (bool) [create,query]
Turns off node timing. By default, the timers on all nodes are turned off, but if specified with the -name or -type
flags, only the timers on specified nodes are turned off. If the timers on all nodes become turned off, then global
timing is also turned off as well.
- timerOn : on (bool) [create,query]
Turns on node timing. By default, the timers on all nodes are turned on, but if specified with the -name or -type flags,
only the timers on specified nodes are turned on. The global timers are also turned on by this command. Note that
turning on timing does NOT reset the timers to zero. Use the -reset flag to reset the timers. The idea for NOT resetting
the timers is to allow the user to arbitrarily turn timing on and off and continue to add to the existing timer values.
- trace : tr (bool) [create]
Turns on or off detailed execution tracing. By default, tracing is off. If enabled, each timeable operation is logged
when it starts and again when it ends. This flag can be used in conjunction with -outputFile to specify where the output
is generated to. The following example shows how the output is formatted:dgtimer:begin: compute 3 particleShape1Deformed
particleShape1Deformed.lastPosition The above is an example of the output when -trace is true that marks the start of an
operation. For specific details on each field: the dgtimer:begin:string is an identifying marker to flag that this is a
begin operation record. The second argument, computein our example, is the operation metric. You can view the output of
each given metric via dgtimer -qby specifying the -show flag. The integer which follows (3 in this case) is the depth in
the operation stack, and the third argument is the name of the node (particleShape1Deformed). The fourth argument is
specific to the metric. For compute, it gives the name of the plug being computed. For callback, its the internal Maya
name of the callback. For dirty, its the name of the plug that dirtiness is being propagated from.dgtimer:end: compute 3
particleShape1Deformed 0.000305685 0.000305685 The above is the end operation record. The compute, 3and
particleShapeDeformedarguments were described in the dgtimer:beginoverview earlier. The two floating-point arguments are
self time and inclusive time for the operation measured in seconds. The inclusive measure lists the total time since the
matching dgtimer:begin:entry for this operation, while the self measure lists the inclusive time minus any time consumed
by child operations which may have occurred during execution of the current operation. As noted elsewhere in this
document, these two times are wall clock times, measuring elapsed time including any time in which Maya was idle or
performing system calls. Since dgtimer can measure some non-node qualities in Maya, such as global message callbacks, a
-is displayed where the node name would ordinarily be displayed. The -means not applicable.
- type : t (unicode) [create,query]
Used in conjunction with -reset or -query to specify the type of the node(s) (e.g. animCurveTA) to reset or print timer
values for. When querying, use of the -combineType flag will cause all nodes of the same type to be combined into one
entry, and only one line of output is generated (i.e. the global timers and header information is omitted). Note: the
-name and -type flag cannot be used together.
- uniqueName : un (bool) [create,query]
Used to specify that the DAG nodes listed in the output should be listed by their unique names. The full DAG path to
the object will be printed out instead of just the node name.
- updateHeatMap : uhm (int) [create]
Forces Maya's heat map to rebuild based on the specified parameters. The heat map is an internal dgtimer structure used
in mapping intensity values to colourmap entries during display by the HyperGraph Editor. There is one heat map shared
by all editors that are using heat map display mode. Updating the heat map causes the timer values on all nodes to be
analysed to compose the distribution of entries in the heat map. The parameter is the integer number of divisions in the
map and should equal the number of available colours for displaying the heat map. This flag can be specified with the
-rangeLower and -rangeUpper flags to limit the range of displayable to lie between the percentile range. The dgtimer
command returns the maximum timing value for all nodes in Maya for the specified metric and type. Note: when the display
range includes 0, the special zeroth (exactly zero) slot in the heat map is avilable.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dgtimer`
|
mayaSDK/pymel/core/system.py
|
dgtimer
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def dgtimer(*args, **kwargs):
"\n This command measures dependency graph node performance by managing timers on a per-node basis. Logically, each DG node\n has a timer associated with it which records the amount of real time spent in various operations on its plugs. The time\n measurement includes the cost of copying data to the node on behalf of the operation, MEL commands executed by an\n expression contained in an expression invoked by the node, and includes any wait time such as when a fileTexture node\n loads an image file from disk. Most DG operations are reported including compute, draw, and dirty propagation. The\n various operations we measure are called metricsand the types of timers are called timer types. The various metrics are\n always measured when timing is on, but are only queried when specified via the -show and -hide flags. The metrics\n currently supported are listed in detail under the -show flag below. For each metric we support a standard set of timer\n types. There are three of these: selffor self time (the time specific to the node and not its children), inclusive(time\n including children of the node), and count(number of operations of the given metric on the node). The timing mechanism\n which is used by dgtimeris built into the DG itself, thus ALL depend nodes can be timed and there is no need for\n programmers writing plug-ins using the OpenMaya API to add any special code in order for their nodes to be timed -- its\n all handled transparently. The dgtimercommand allows node timers to be turned on, off, reset to zero, and have their\n current value displayed, and these operations can be performed globally on all nodes or on a specific set of nodes\n defined by name, type or parentage. Note that all timer measurements are computed in real time(the same time measurement\n you get from a wristwatch) as opposed to CPU time(which only measures time when the processor is executing your code).\n All times are displayed in seconds. Use the -query flag to display the current timer values on a node, use -on to turn\n on timing, use -off to turn off timing, and -reset to reset timers to zero. To display the values measured during\n timing, there are two approaches. The first method is to use the -query flag can be used to report the information which\n has been measured. The second method is to use the query methods available on the OpenMaya class MFnDependencyNode (see\n the OpenMaya documentation for details). What follows is a description of what is generated via -query. The output is\n broken out into several sections and these are described as follows: SECTION 1:Section 1 of the dgtimer output contains\n global information. This section can be disabled via the -hoHeader flag. These values are reset whenever a global timer\n reset occurs (i.e. dgtimer -reset;is specified). The global values which are reported are: Total real time:the total\n wall-clock time since the last global timer reset. This is the actual time which has been spent as you might measure it\n measure it with your watch. On a multi-processing system, this value will always remain true to to real time (unlike\n userand systime).Total user time:the total time the CPU(s) spent processing Maya not including any system time since the\n last global timer reset.Total sys time:the total time the CPU(s) spent in operating system calls on behalf of Maya since\n the last global timer reset. Summary of each metric for all nodes:a summary of self and count for each metric that we\n measure:Real time in callbacksreports the self time and count for the callbackmetric.Real time in computereports the\n self time and count for the computemetric.Real time in dirty propagationreports the self time and count for the\n dirtymetric.Real time in drawingreports the self time and count for the drawmetric.Real time fetching data from\n plugsreports the self time and count for the fetchmetric.Breakdown of select metrics in greater detail:a reporting of\n certain combinations of metrics that we measure:Real time in compute invoked from callbackreports the self time spent in\n compute when invoked either directly or indirectly by a callback.Real time in compute not invoked from callbackreports\n the self time spent in compute not invoked either directly or indirectly by a callback.SECTION 2:Section 2 of the\n dgtimer -query output contains per-node information. There is a header which describes the meaning of each column,\n followed by the actual per-node data, and this is ultimately followed by a footer which summarises the totals per\n column. Note that the data contained in the footer is the global total for each metric and will include any nodes that\n have been deleted since the last reset, so the value in the footer MAY exceed what you get when you total the individual\n values in the column. To prevent the header and footer from appearing, use the -noHeader flag to just display the per-\n node data. The columns which are displayed are as follows: Rank:The order of this node in the sorted list of all nodes,\n where the list is sorted by -sortMetric and -sortType flag values (if these are omitted the default is to sort by self\n compute time).ON:Tells you if the timer for that node is currently on or off. (With dgtimer, you have the ability to\n turn timing on and off on a per-node basis).Per-metric information:various columns are reported for each metric. The\n name of the metric is reported at in the header in capital letters (e.g. DRAW). The standard columns for each metric\n are:Self:The amount of real time (i.e. elapsed time as you might measure it with a stopwatch) spent performing the\n operation (thus if the metric is DRAW, then this will be time spent drawing the node).Inclusive:The amount of real time\n (i.e. elapsed time as you might measure it with a stopwatch) spent performing the operation including any child\n operations that were invoked on behalf of the operation (thus if the metric is DRAW, then this will be the total time\n taken to draw the node including any child operations).Count:The number of operations that occued on this node (thus if\n the metric is DRAW, then the number of draw operations on the node will be reported).Sort informationif a column is the\n one being used to sort all the per-node dgtimer information, then that column is followed by a Percentand\n Cumulativecolumn which describe a running total through the listing. Note that -sortType noneprevents these two columns\n from appearing and implicitely sorts on selftime.After the per-metric columns, the node name and type are\n reported:TypeThe node type.NameThe name of the node. If the node is file referenced and you are using namespaces, the\n namespace will be included. You can also force the dagpath to be displayed by specifying the -uniqueName flag.Plug-in\n nameIf the node was implemented in an OpenMaya plug-in, the name of that plug-in is reported.SECTION 3:Section 3 of the\n dgtimer -query output describes time spent in callbacks. Note that section 3 only appears when the CALLBACK metric is\n shown (see the -show flag). The first part is SECTION 3.1 lists the time per callback with each entry comprising: The\n name of the callback, such as attributeChangedMsg. These names are internal Maya names, and in the cases where the\n callback is available through the OpenMaya API, the API access to the callback is similarly named.The name is followed\n by a breakdown per callbackId. The callbackId is an identifying number which is unique to each client that is registered\n to a callback and can be deduced by the user, such as through the OpenMaya API. You can cross-reference by finding the\n same callbackId value listed in SECTIONs 3.1 and 3.3.Self time (i.e. real time spent within that callbackId type not\n including any child operations which occur while processing the callback).Percent (see the -sortType flag). Note that\n the percent values are listed to sum up to 100% for that callback. This is not a global percent.Cumulative (see the\n -sortType flag).Inclusive time (i.e. real time spent within that callbackId including any child operations).Count\n (number of times the callbackId was invoked).API lists Yif the callbackId was defined through the OpenMaya API, and Nif\n the callbackId was defined internally within Maya.Node lists the name of the node this callbackId was associated with.\n If the callbackId was associated with more than one node, the string \\*multiple\\*is printed. If there was no node\n associated with the callbackId (or its a callback type in which the node is hard to deduce), the entry is blank.After\n the callbackId entries are listed, a dashed line is printed followed by a single line listing the self, inclusive and\n count values for the callback. Note that the percent is relative to the global callback time.At the bottom of SECTION\n 3.1 is the per-column total. The values printed match the summation at the bottom of the listing in section 2. Note that\n the values from SECTION 3.1 include any nodes that have been deleted since the last reset. The thresholding parameters\n (-threshold, -rangeLower, -rangeUpper and -maxDisplay) are honoured when generating the listing. The sorting of the rows\n and display of the Percent and Cumulative columns obeys the -sortType flag. As the listing can be long, zero entries are\n not displayed. The second part is SECTION 3.2 which lists the data per callbackId. As noted earlier, the callbackId is\n an identifying number which is unique to each client that is registered to a callback and can be deduced by the user,\n such as through the OpenMaya API. The entries in SECTION 3.2 appear as follows: CallbackId the numeric identifier for\n the callback. You can cross reference by finding the same callbackId value listed in SECTIONs 3.1 and 3.3.For each\n callbackId, the data is broken down per-callback:Callback the name of the callback, e.g. attributeChangedMsg.Percent,\n Cumulative, Inclusive, Count, API and Node entries as described in SECTION 3.1.After the callback entries are listed for\n the callbackId, a dashed followed by a summary line is printed. The summary line lists the self, inclusive and count\n values for the callback. Note that the percent is relative to the global callback time.The third part is SECTION 3.3\n which lists data per-callback per-node. The nodes are sorted based on the -sortType flag, and for each node, the\n callbacks are listed, also sorted based on the -sortType flag. As this listing can be long, zero entries are not\n displayed. An important note for SECTION 3.3 is that only nodes which still exist are displayed. If a node has been\n deleted, no infromation is listed.\n \n Flags:\n - combineType : ct (bool) [query]\n Causes all nodes of the same type (e.g. animCurveTA) to be combined in the output display.\n \n - hide : hi (unicode) [create,query]\n This flag is the converse of -show. As with -show, it is a query-only flag which can be specified multiple times. If you\n do specify -hide, we display all columns except those listed by the -hide flags.\n \n - hierarchy : h (bool) [create,query]\n Used to specify that a hierarchy of the dependency graph be affected, thus -reset -hierarchy -name ballwill reset the\n timers on the node named balland all of its descendents in the dependency graph.\n \n - maxDisplay : m (int) [query]\n Truncates the display so that only the most expenive nentries are printed in the output display.\n \n - name : n (unicode) [create,query]\n Used in conjunction with -reset or -query to specify the name of the node to reset or print timer values for. When\n querying a single timer, only a single line of output is generated (i.e. the global timers and header information is\n omitted). Note that one can force output to the script editor window via the -outputFile MELoption to make it easy to\n grab the values in a MEL script. Note: the -name and -type flag cannot be used together.\n \n - noHeader : nh (bool) [create,query]\n Used in conjunction with -query to prevent any header or footer information from being printed. All that will be output\n is the per-node timing data. This option makes it easier to parse the output such as when you output the query to a file\n on disk using the -outputFileoption.\n \n - outputFile : o (unicode) [query]\n Specifies where the output of timing or tracing is displayed. The flag takes a string argument which accepts three\n possible values: The name of a file on disk.Or the keyword stdout, which causes output to be displayed on the terminal\n window (Linux and Macintosh), and the status window on Windows.Or the keyword MEL, which causes output to be displayed\n in the Maya Script Editor (only supported with -query).The stdoutsetting is the default behaviour. This flag can be used\n with the -query flag as well as the -trace flag. When used with the -trace flag, any tracing output will be displayed on\n the destination specified by the -outputFile (or stdout if -outputFile is omitted). Tracing operations will continue to\n output to the destination until you specify the -trace and -outputFile flags again. When used with the -query flag,\n timing output will be displayed to the destination specified by the -outputFile (or stdoutif -outputFile is omitted).\n Here are some examples of how to use the -query, -trace and -outputFile flags: Example: output the timing information to\n a single file on disk:dgtimer -on; // Turn on timing create some animated scene\n content; play -wait; // Play the scene through dgtimer -query -outputFile\n /tmp/timing.txt// Output node timing information to a file on disk Example: output the tracing information to a single\n file on disk:dgtimer -on; // Turn on timing create some animated scene content;\n dgtimer -trace on -outputFile /tmp/trace.txt// Turn on tracing and output the results to file play -wait;\n // Play the scene through; trace info goes to /tmp/trace.txt dgtimer -query; // But\n the timing info goes to the terminal window play -wait; // Play the scene again,\n trace info still goes to /tmp/trace.txt Example: two runs, outputting the trace information and timing information to\n separate files:dgtimer -on; // Turn on timing create some animated scene content;\n dgtimer -trace on -outputFile /tmp/trace1.txt// Turn on tracing and output the results to file play -wait;\n // Play the scene through dgtimer -query -outputFile /tmp/query1.txt// Output node timing information to another file\n dgtimer -reset; dgtimer -trace on -outputFile /tmp/trace2.txt// Output tracing results to different file play -wait;\n // Play the scene through dgtimer -query -outputFile /tmp/query2.txt// Output node timing information to another file\n Tips and tricks:Outputting the timing results to the script editor makes it easy to use the results in MEL e.g. string\n $timing[] = `dgtimer -query -outputFile MEL`.It is important to note that the -outputFile you specify with -trace is\n totally independent from the one you specify with -query.If the file you specify already exists, Maya will empty the\n file first before outputting data to it (and if the file is not writable, an error is generated instead).\n \n - overhead : oh (bool) [create,query]\n Turns on and off the measurement of timing overhead. Under ordinary circumstances the amount of timing overhead is\n minimal compared with the events being measured, but in complex scenes, one might find the overhead to be measurable. By\n default this option is turned off. To enable it, specify dgtimer -overhead trueprior to starting timing. When querying\n timing, the overhead is reported in SECTION 1.2 of the dgtimer output and is not factored out of each individual\n operation.\n \n - rangeLower : rgl (float) [create]\n This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map\n with -updateHeatMap. The value is the lower percentage cutoff for the nodes which are processed. There is also a\n -rangeLower flag which sets the lower range limit. The default value is 0, meaning that all nodes with timing value\n below the upper range limit are considered.\n \n - rangeUpper : rgu (float) [create]\n This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map\n with -updateHeatMap. The value is the upper percentage cutoff for the nodes which are processed. There is also a\n -rangeLower flag which sets the lower range limit. The default value is 100, meaning that all nodes with timing value\n above the lower range limit are considered.\n \n - reset : r (bool) [create]\n Resets the node timers to zero. By default, the timers on all nodes as well as the global timers are reset, but if\n specified with the -name or -type flags, only the timers on specified nodes are reset.\n \n - returnCode : rc (unicode) [create,query]\n This flag has been replaced by the more general -returnType flag. The -returnCode flag was unfortunately specific to the\n compute metric only. It exists only for backwards compatability purposes. It will be removed altogether in a future\n release. Here are some handy equivalences: To get the total number of nodes:OLD WAY: dgtimer -rc nodecount -q;//\n Result:325//NEW WAY: dgtimer -returnType total -sortType none -q;// Result:325//OLD WAY: dgtimer -rc count -q;//\n Result:1270//To get the sum of the compute count column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType\n count -q;// Result:1270//OLD WAY: dgtimer -rc selftime -q;// Result:0.112898//To get the sum of the compute self\n column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType self -q;// Result:0.112898//\n \n - returnType : rt (unicode) [query]\n This flag specifies what the double value returned by the dgtimer command represents. By default, the value returned is\n the global total as displayed in SECTION 1 for the column we are sorting on in the per-node output (the sort column can\n be specified via the -sortMetric and -sortType flags). However, instead of the total being returned, the user can\n instead request the individual entries for the column. This flag is useful mainly for querying without forcing any\n output. The flag accepts the values total, to just display the column total, or allto display all entries individually.\n For example, if you want to get the total of draw self time without any other output simply specify the following:\n dgtimer -returnType total -sortMetric draw -sortType self -threshold 100 -noHeader -query;// Result: 7718.01 // To\n instead get each individual entry, change the above query to: dgtimer -returnType all -sortMetric draw -sortType self\n -threshold 100 -noHeader -query;// Result: 6576.01 21.91 11.17 1108.92 // To get the inclusive dirty time for a specific\n node, use -name as well as -returnType all: dgtimer -name virginia-returnType all -sortMetric dirty -sortType inclusive\n -threshold 100 -noHeader -query;Note: to get the total number of nodes, use -sortType none -returnType total. To get\n the on/off status for each node, use -sortType none -returnType all.\n \n - show : sh (unicode) [create,query]\n Used in conjunction with -query to specify which columns are to be displayed in the per-node section of the output.\n -show takes an argument, which can be all(to display all columns), callback(to display the time spent during any\n callback processing on the node not due to evaluation), compute(to display the time spent in the node's compute\n methods), dirty(to display time spent propagating dirtiness on behalf of the node), draw(to display time spent drawing\n the node), compcb(to display time spent during callback processing on node due to compute), and compncb(to display time\n spent during callback processing on node NOT due to compute). The -show flag can be used multiple times, but cannot be\n specified with -hide. By default, if neither -show, -hide, or -sort are given, the effective display mode is: dgtimer\n -show compute -query.\n \n - sortMetric : sm (unicode) [create,query]\n Used in conjunction with -query to specify which metric is to be sorted on when the per-node section of the output is\n generated, for example drawtime. Note that the -sortType flag can also be specified to define which timer is sorted on:\n for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was\n drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortMetric flag can\n only be specified at most once. The flag takes the following arguments: callback(to sort on time spent during any\n callback processing on the node), compute(to sort on the time spent in the node's compute methods), dirty(to sort on the\n time spent propagating dirtiness on behalf of the node), draw(to sort on time spent drawing the node), fetch(to sort on\n time spent copying data from the datablock), The default, if -sortMetric is omitted, is to sort on the first displayed\n column. Note that the sortMetric is independent of which columns are displayed via -show and -hide. Sort on a hidden\n column is allowed. The column selected by -sortMetric and -sortType specifies which total is returned by the dgtimer\n command on the MEL command line. This flag is also used with -updateHeatMap to specify which metric to build the heat\n map for.\n \n - sortType : st (unicode) [create,query]\n Used in conjunction with -query to specify which timer is to be sorted on when the per-node section of the output is\n generated, for example selftime. Note that the -sortMetric flag can also be specified to define which metric is sorted\n on: for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was\n drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortType flag can be\n specified at most once. The flag takes the following arguments: self(to sort on self time, which is the time specific to\n the node and not its children), inclusive(to sort on the time including children of the node), count(to sort on the\n number of times the node was invoked). and none(to sort on self time, but do not display the Percent and Cumulative\n columns in the per-node display, as well as cause the total number of nodes in Maya to be returned on the command line).\n The default, if -sortType is omitted, is to sort on self time. The column selected by -sortMetric and -sortType\n specifies which total is returned by the dgtimer command on the MEL command line. The global total as displayed in\n SECTION 1 of the listing is returned. The special case of -sortType nonecauses the number of nodes in Maya to instead be\n returned. This flag is also used with -updateHeatMap to specify which metric to build the heat map for.\n \n - threshold : th (float) [query]\n Truncates the display once the value falls below the threshold value. The threshold applies to whatever timer is being\n used for sorting. For example, if our sort key is self compute time (i.e. -sortMetric is computeand -sortType is self)\n and the threshold parameter is 20.0, then only nodes with a compute self-time of 20.0 or higher will be displayed. (Note\n that -threshold uses absolute time. There are the similar -rangeUpper and -rangeLower parameters which specify a range\n using percentage).\n \n - timerOff : off (bool) [create,query]\n Turns off node timing. By default, the timers on all nodes are turned off, but if specified with the -name or -type\n flags, only the timers on specified nodes are turned off. If the timers on all nodes become turned off, then global\n timing is also turned off as well.\n \n - timerOn : on (bool) [create,query]\n Turns on node timing. By default, the timers on all nodes are turned on, but if specified with the -name or -type flags,\n only the timers on specified nodes are turned on. The global timers are also turned on by this command. Note that\n turning on timing does NOT reset the timers to zero. Use the -reset flag to reset the timers. The idea for NOT resetting\n the timers is to allow the user to arbitrarily turn timing on and off and continue to add to the existing timer values.\n \n - trace : tr (bool) [create]\n Turns on or off detailed execution tracing. By default, tracing is off. If enabled, each timeable operation is logged\n when it starts and again when it ends. This flag can be used in conjunction with -outputFile to specify where the output\n is generated to. The following example shows how the output is formatted:dgtimer:begin: compute 3 particleShape1Deformed\n particleShape1Deformed.lastPosition The above is an example of the output when -trace is true that marks the start of an\n operation. For specific details on each field: the dgtimer:begin:string is an identifying marker to flag that this is a\n begin operation record. The second argument, computein our example, is the operation metric. You can view the output of\n each given metric via dgtimer -qby specifying the -show flag. The integer which follows (3 in this case) is the depth in\n the operation stack, and the third argument is the name of the node (particleShape1Deformed). The fourth argument is\n specific to the metric. For compute, it gives the name of the plug being computed. For callback, its the internal Maya\n name of the callback. For dirty, its the name of the plug that dirtiness is being propagated from.dgtimer:end: compute 3\n particleShape1Deformed 0.000305685 0.000305685 The above is the end operation record. The compute, 3and\n particleShapeDeformedarguments were described in the dgtimer:beginoverview earlier. The two floating-point arguments are\n self time and inclusive time for the operation measured in seconds. The inclusive measure lists the total time since the\n matching dgtimer:begin:entry for this operation, while the self measure lists the inclusive time minus any time consumed\n by child operations which may have occurred during execution of the current operation. As noted elsewhere in this\n document, these two times are wall clock times, measuring elapsed time including any time in which Maya was idle or\n performing system calls. Since dgtimer can measure some non-node qualities in Maya, such as global message callbacks, a\n -is displayed where the node name would ordinarily be displayed. The -means not applicable.\n \n - type : t (unicode) [create,query]\n Used in conjunction with -reset or -query to specify the type of the node(s) (e.g. animCurveTA) to reset or print timer\n values for. When querying, use of the -combineType flag will cause all nodes of the same type to be combined into one\n entry, and only one line of output is generated (i.e. the global timers and header information is omitted). Note: the\n -name and -type flag cannot be used together.\n \n - uniqueName : un (bool) [create,query]\n Used to specify that the DAG nodes listed in the output should be listed by their unique names. The full DAG path to\n the object will be printed out instead of just the node name.\n \n - updateHeatMap : uhm (int) [create]\n Forces Maya's heat map to rebuild based on the specified parameters. The heat map is an internal dgtimer structure used\n in mapping intensity values to colourmap entries during display by the HyperGraph Editor. There is one heat map shared\n by all editors that are using heat map display mode. Updating the heat map causes the timer values on all nodes to be\n analysed to compose the distribution of entries in the heat map. The parameter is the integer number of divisions in the\n map and should equal the number of available colours for displaying the heat map. This flag can be specified with the\n -rangeLower and -rangeUpper flags to limit the range of displayable to lie between the percentile range. The dgtimer\n command returns the maximum timing value for all nodes in Maya for the specified metric and type. Note: when the display\n range includes 0, the special zeroth (exactly zero) slot in the heat map is avilable.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgtimer`\n "
pass
|
def dgtimer(*args, **kwargs):
"\n This command measures dependency graph node performance by managing timers on a per-node basis. Logically, each DG node\n has a timer associated with it which records the amount of real time spent in various operations on its plugs. The time\n measurement includes the cost of copying data to the node on behalf of the operation, MEL commands executed by an\n expression contained in an expression invoked by the node, and includes any wait time such as when a fileTexture node\n loads an image file from disk. Most DG operations are reported including compute, draw, and dirty propagation. The\n various operations we measure are called metricsand the types of timers are called timer types. The various metrics are\n always measured when timing is on, but are only queried when specified via the -show and -hide flags. The metrics\n currently supported are listed in detail under the -show flag below. For each metric we support a standard set of timer\n types. There are three of these: selffor self time (the time specific to the node and not its children), inclusive(time\n including children of the node), and count(number of operations of the given metric on the node). The timing mechanism\n which is used by dgtimeris built into the DG itself, thus ALL depend nodes can be timed and there is no need for\n programmers writing plug-ins using the OpenMaya API to add any special code in order for their nodes to be timed -- its\n all handled transparently. The dgtimercommand allows node timers to be turned on, off, reset to zero, and have their\n current value displayed, and these operations can be performed globally on all nodes or on a specific set of nodes\n defined by name, type or parentage. Note that all timer measurements are computed in real time(the same time measurement\n you get from a wristwatch) as opposed to CPU time(which only measures time when the processor is executing your code).\n All times are displayed in seconds. Use the -query flag to display the current timer values on a node, use -on to turn\n on timing, use -off to turn off timing, and -reset to reset timers to zero. To display the values measured during\n timing, there are two approaches. The first method is to use the -query flag can be used to report the information which\n has been measured. The second method is to use the query methods available on the OpenMaya class MFnDependencyNode (see\n the OpenMaya documentation for details). What follows is a description of what is generated via -query. The output is\n broken out into several sections and these are described as follows: SECTION 1:Section 1 of the dgtimer output contains\n global information. This section can be disabled via the -hoHeader flag. These values are reset whenever a global timer\n reset occurs (i.e. dgtimer -reset;is specified). The global values which are reported are: Total real time:the total\n wall-clock time since the last global timer reset. This is the actual time which has been spent as you might measure it\n measure it with your watch. On a multi-processing system, this value will always remain true to to real time (unlike\n userand systime).Total user time:the total time the CPU(s) spent processing Maya not including any system time since the\n last global timer reset.Total sys time:the total time the CPU(s) spent in operating system calls on behalf of Maya since\n the last global timer reset. Summary of each metric for all nodes:a summary of self and count for each metric that we\n measure:Real time in callbacksreports the self time and count for the callbackmetric.Real time in computereports the\n self time and count for the computemetric.Real time in dirty propagationreports the self time and count for the\n dirtymetric.Real time in drawingreports the self time and count for the drawmetric.Real time fetching data from\n plugsreports the self time and count for the fetchmetric.Breakdown of select metrics in greater detail:a reporting of\n certain combinations of metrics that we measure:Real time in compute invoked from callbackreports the self time spent in\n compute when invoked either directly or indirectly by a callback.Real time in compute not invoked from callbackreports\n the self time spent in compute not invoked either directly or indirectly by a callback.SECTION 2:Section 2 of the\n dgtimer -query output contains per-node information. There is a header which describes the meaning of each column,\n followed by the actual per-node data, and this is ultimately followed by a footer which summarises the totals per\n column. Note that the data contained in the footer is the global total for each metric and will include any nodes that\n have been deleted since the last reset, so the value in the footer MAY exceed what you get when you total the individual\n values in the column. To prevent the header and footer from appearing, use the -noHeader flag to just display the per-\n node data. The columns which are displayed are as follows: Rank:The order of this node in the sorted list of all nodes,\n where the list is sorted by -sortMetric and -sortType flag values (if these are omitted the default is to sort by self\n compute time).ON:Tells you if the timer for that node is currently on or off. (With dgtimer, you have the ability to\n turn timing on and off on a per-node basis).Per-metric information:various columns are reported for each metric. The\n name of the metric is reported at in the header in capital letters (e.g. DRAW). The standard columns for each metric\n are:Self:The amount of real time (i.e. elapsed time as you might measure it with a stopwatch) spent performing the\n operation (thus if the metric is DRAW, then this will be time spent drawing the node).Inclusive:The amount of real time\n (i.e. elapsed time as you might measure it with a stopwatch) spent performing the operation including any child\n operations that were invoked on behalf of the operation (thus if the metric is DRAW, then this will be the total time\n taken to draw the node including any child operations).Count:The number of operations that occued on this node (thus if\n the metric is DRAW, then the number of draw operations on the node will be reported).Sort informationif a column is the\n one being used to sort all the per-node dgtimer information, then that column is followed by a Percentand\n Cumulativecolumn which describe a running total through the listing. Note that -sortType noneprevents these two columns\n from appearing and implicitely sorts on selftime.After the per-metric columns, the node name and type are\n reported:TypeThe node type.NameThe name of the node. If the node is file referenced and you are using namespaces, the\n namespace will be included. You can also force the dagpath to be displayed by specifying the -uniqueName flag.Plug-in\n nameIf the node was implemented in an OpenMaya plug-in, the name of that plug-in is reported.SECTION 3:Section 3 of the\n dgtimer -query output describes time spent in callbacks. Note that section 3 only appears when the CALLBACK metric is\n shown (see the -show flag). The first part is SECTION 3.1 lists the time per callback with each entry comprising: The\n name of the callback, such as attributeChangedMsg. These names are internal Maya names, and in the cases where the\n callback is available through the OpenMaya API, the API access to the callback is similarly named.The name is followed\n by a breakdown per callbackId. The callbackId is an identifying number which is unique to each client that is registered\n to a callback and can be deduced by the user, such as through the OpenMaya API. You can cross-reference by finding the\n same callbackId value listed in SECTIONs 3.1 and 3.3.Self time (i.e. real time spent within that callbackId type not\n including any child operations which occur while processing the callback).Percent (see the -sortType flag). Note that\n the percent values are listed to sum up to 100% for that callback. This is not a global percent.Cumulative (see the\n -sortType flag).Inclusive time (i.e. real time spent within that callbackId including any child operations).Count\n (number of times the callbackId was invoked).API lists Yif the callbackId was defined through the OpenMaya API, and Nif\n the callbackId was defined internally within Maya.Node lists the name of the node this callbackId was associated with.\n If the callbackId was associated with more than one node, the string \\*multiple\\*is printed. If there was no node\n associated with the callbackId (or its a callback type in which the node is hard to deduce), the entry is blank.After\n the callbackId entries are listed, a dashed line is printed followed by a single line listing the self, inclusive and\n count values for the callback. Note that the percent is relative to the global callback time.At the bottom of SECTION\n 3.1 is the per-column total. The values printed match the summation at the bottom of the listing in section 2. Note that\n the values from SECTION 3.1 include any nodes that have been deleted since the last reset. The thresholding parameters\n (-threshold, -rangeLower, -rangeUpper and -maxDisplay) are honoured when generating the listing. The sorting of the rows\n and display of the Percent and Cumulative columns obeys the -sortType flag. As the listing can be long, zero entries are\n not displayed. The second part is SECTION 3.2 which lists the data per callbackId. As noted earlier, the callbackId is\n an identifying number which is unique to each client that is registered to a callback and can be deduced by the user,\n such as through the OpenMaya API. The entries in SECTION 3.2 appear as follows: CallbackId the numeric identifier for\n the callback. You can cross reference by finding the same callbackId value listed in SECTIONs 3.1 and 3.3.For each\n callbackId, the data is broken down per-callback:Callback the name of the callback, e.g. attributeChangedMsg.Percent,\n Cumulative, Inclusive, Count, API and Node entries as described in SECTION 3.1.After the callback entries are listed for\n the callbackId, a dashed followed by a summary line is printed. The summary line lists the self, inclusive and count\n values for the callback. Note that the percent is relative to the global callback time.The third part is SECTION 3.3\n which lists data per-callback per-node. The nodes are sorted based on the -sortType flag, and for each node, the\n callbacks are listed, also sorted based on the -sortType flag. As this listing can be long, zero entries are not\n displayed. An important note for SECTION 3.3 is that only nodes which still exist are displayed. If a node has been\n deleted, no infromation is listed.\n \n Flags:\n - combineType : ct (bool) [query]\n Causes all nodes of the same type (e.g. animCurveTA) to be combined in the output display.\n \n - hide : hi (unicode) [create,query]\n This flag is the converse of -show. As with -show, it is a query-only flag which can be specified multiple times. If you\n do specify -hide, we display all columns except those listed by the -hide flags.\n \n - hierarchy : h (bool) [create,query]\n Used to specify that a hierarchy of the dependency graph be affected, thus -reset -hierarchy -name ballwill reset the\n timers on the node named balland all of its descendents in the dependency graph.\n \n - maxDisplay : m (int) [query]\n Truncates the display so that only the most expenive nentries are printed in the output display.\n \n - name : n (unicode) [create,query]\n Used in conjunction with -reset or -query to specify the name of the node to reset or print timer values for. When\n querying a single timer, only a single line of output is generated (i.e. the global timers and header information is\n omitted). Note that one can force output to the script editor window via the -outputFile MELoption to make it easy to\n grab the values in a MEL script. Note: the -name and -type flag cannot be used together.\n \n - noHeader : nh (bool) [create,query]\n Used in conjunction with -query to prevent any header or footer information from being printed. All that will be output\n is the per-node timing data. This option makes it easier to parse the output such as when you output the query to a file\n on disk using the -outputFileoption.\n \n - outputFile : o (unicode) [query]\n Specifies where the output of timing or tracing is displayed. The flag takes a string argument which accepts three\n possible values: The name of a file on disk.Or the keyword stdout, which causes output to be displayed on the terminal\n window (Linux and Macintosh), and the status window on Windows.Or the keyword MEL, which causes output to be displayed\n in the Maya Script Editor (only supported with -query).The stdoutsetting is the default behaviour. This flag can be used\n with the -query flag as well as the -trace flag. When used with the -trace flag, any tracing output will be displayed on\n the destination specified by the -outputFile (or stdout if -outputFile is omitted). Tracing operations will continue to\n output to the destination until you specify the -trace and -outputFile flags again. When used with the -query flag,\n timing output will be displayed to the destination specified by the -outputFile (or stdoutif -outputFile is omitted).\n Here are some examples of how to use the -query, -trace and -outputFile flags: Example: output the timing information to\n a single file on disk:dgtimer -on; // Turn on timing create some animated scene\n content; play -wait; // Play the scene through dgtimer -query -outputFile\n /tmp/timing.txt// Output node timing information to a file on disk Example: output the tracing information to a single\n file on disk:dgtimer -on; // Turn on timing create some animated scene content;\n dgtimer -trace on -outputFile /tmp/trace.txt// Turn on tracing and output the results to file play -wait;\n // Play the scene through; trace info goes to /tmp/trace.txt dgtimer -query; // But\n the timing info goes to the terminal window play -wait; // Play the scene again,\n trace info still goes to /tmp/trace.txt Example: two runs, outputting the trace information and timing information to\n separate files:dgtimer -on; // Turn on timing create some animated scene content;\n dgtimer -trace on -outputFile /tmp/trace1.txt// Turn on tracing and output the results to file play -wait;\n // Play the scene through dgtimer -query -outputFile /tmp/query1.txt// Output node timing information to another file\n dgtimer -reset; dgtimer -trace on -outputFile /tmp/trace2.txt// Output tracing results to different file play -wait;\n // Play the scene through dgtimer -query -outputFile /tmp/query2.txt// Output node timing information to another file\n Tips and tricks:Outputting the timing results to the script editor makes it easy to use the results in MEL e.g. string\n $timing[] = `dgtimer -query -outputFile MEL`.It is important to note that the -outputFile you specify with -trace is\n totally independent from the one you specify with -query.If the file you specify already exists, Maya will empty the\n file first before outputting data to it (and if the file is not writable, an error is generated instead).\n \n - overhead : oh (bool) [create,query]\n Turns on and off the measurement of timing overhead. Under ordinary circumstances the amount of timing overhead is\n minimal compared with the events being measured, but in complex scenes, one might find the overhead to be measurable. By\n default this option is turned off. To enable it, specify dgtimer -overhead trueprior to starting timing. When querying\n timing, the overhead is reported in SECTION 1.2 of the dgtimer output and is not factored out of each individual\n operation.\n \n - rangeLower : rgl (float) [create]\n This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map\n with -updateHeatMap. The value is the lower percentage cutoff for the nodes which are processed. There is also a\n -rangeLower flag which sets the lower range limit. The default value is 0, meaning that all nodes with timing value\n below the upper range limit are considered.\n \n - rangeUpper : rgu (float) [create]\n This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map\n with -updateHeatMap. The value is the upper percentage cutoff for the nodes which are processed. There is also a\n -rangeLower flag which sets the lower range limit. The default value is 100, meaning that all nodes with timing value\n above the lower range limit are considered.\n \n - reset : r (bool) [create]\n Resets the node timers to zero. By default, the timers on all nodes as well as the global timers are reset, but if\n specified with the -name or -type flags, only the timers on specified nodes are reset.\n \n - returnCode : rc (unicode) [create,query]\n This flag has been replaced by the more general -returnType flag. The -returnCode flag was unfortunately specific to the\n compute metric only. It exists only for backwards compatability purposes. It will be removed altogether in a future\n release. Here are some handy equivalences: To get the total number of nodes:OLD WAY: dgtimer -rc nodecount -q;//\n Result:325//NEW WAY: dgtimer -returnType total -sortType none -q;// Result:325//OLD WAY: dgtimer -rc count -q;//\n Result:1270//To get the sum of the compute count column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType\n count -q;// Result:1270//OLD WAY: dgtimer -rc selftime -q;// Result:0.112898//To get the sum of the compute self\n column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType self -q;// Result:0.112898//\n \n - returnType : rt (unicode) [query]\n This flag specifies what the double value returned by the dgtimer command represents. By default, the value returned is\n the global total as displayed in SECTION 1 for the column we are sorting on in the per-node output (the sort column can\n be specified via the -sortMetric and -sortType flags). However, instead of the total being returned, the user can\n instead request the individual entries for the column. This flag is useful mainly for querying without forcing any\n output. The flag accepts the values total, to just display the column total, or allto display all entries individually.\n For example, if you want to get the total of draw self time without any other output simply specify the following:\n dgtimer -returnType total -sortMetric draw -sortType self -threshold 100 -noHeader -query;// Result: 7718.01 // To\n instead get each individual entry, change the above query to: dgtimer -returnType all -sortMetric draw -sortType self\n -threshold 100 -noHeader -query;// Result: 6576.01 21.91 11.17 1108.92 // To get the inclusive dirty time for a specific\n node, use -name as well as -returnType all: dgtimer -name virginia-returnType all -sortMetric dirty -sortType inclusive\n -threshold 100 -noHeader -query;Note: to get the total number of nodes, use -sortType none -returnType total. To get\n the on/off status for each node, use -sortType none -returnType all.\n \n - show : sh (unicode) [create,query]\n Used in conjunction with -query to specify which columns are to be displayed in the per-node section of the output.\n -show takes an argument, which can be all(to display all columns), callback(to display the time spent during any\n callback processing on the node not due to evaluation), compute(to display the time spent in the node's compute\n methods), dirty(to display time spent propagating dirtiness on behalf of the node), draw(to display time spent drawing\n the node), compcb(to display time spent during callback processing on node due to compute), and compncb(to display time\n spent during callback processing on node NOT due to compute). The -show flag can be used multiple times, but cannot be\n specified with -hide. By default, if neither -show, -hide, or -sort are given, the effective display mode is: dgtimer\n -show compute -query.\n \n - sortMetric : sm (unicode) [create,query]\n Used in conjunction with -query to specify which metric is to be sorted on when the per-node section of the output is\n generated, for example drawtime. Note that the -sortType flag can also be specified to define which timer is sorted on:\n for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was\n drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortMetric flag can\n only be specified at most once. The flag takes the following arguments: callback(to sort on time spent during any\n callback processing on the node), compute(to sort on the time spent in the node's compute methods), dirty(to sort on the\n time spent propagating dirtiness on behalf of the node), draw(to sort on time spent drawing the node), fetch(to sort on\n time spent copying data from the datablock), The default, if -sortMetric is omitted, is to sort on the first displayed\n column. Note that the sortMetric is independent of which columns are displayed via -show and -hide. Sort on a hidden\n column is allowed. The column selected by -sortMetric and -sortType specifies which total is returned by the dgtimer\n command on the MEL command line. This flag is also used with -updateHeatMap to specify which metric to build the heat\n map for.\n \n - sortType : st (unicode) [create,query]\n Used in conjunction with -query to specify which timer is to be sorted on when the per-node section of the output is\n generated, for example selftime. Note that the -sortMetric flag can also be specified to define which metric is sorted\n on: for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was\n drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortType flag can be\n specified at most once. The flag takes the following arguments: self(to sort on self time, which is the time specific to\n the node and not its children), inclusive(to sort on the time including children of the node), count(to sort on the\n number of times the node was invoked). and none(to sort on self time, but do not display the Percent and Cumulative\n columns in the per-node display, as well as cause the total number of nodes in Maya to be returned on the command line).\n The default, if -sortType is omitted, is to sort on self time. The column selected by -sortMetric and -sortType\n specifies which total is returned by the dgtimer command on the MEL command line. The global total as displayed in\n SECTION 1 of the listing is returned. The special case of -sortType nonecauses the number of nodes in Maya to instead be\n returned. This flag is also used with -updateHeatMap to specify which metric to build the heat map for.\n \n - threshold : th (float) [query]\n Truncates the display once the value falls below the threshold value. The threshold applies to whatever timer is being\n used for sorting. For example, if our sort key is self compute time (i.e. -sortMetric is computeand -sortType is self)\n and the threshold parameter is 20.0, then only nodes with a compute self-time of 20.0 or higher will be displayed. (Note\n that -threshold uses absolute time. There are the similar -rangeUpper and -rangeLower parameters which specify a range\n using percentage).\n \n - timerOff : off (bool) [create,query]\n Turns off node timing. By default, the timers on all nodes are turned off, but if specified with the -name or -type\n flags, only the timers on specified nodes are turned off. If the timers on all nodes become turned off, then global\n timing is also turned off as well.\n \n - timerOn : on (bool) [create,query]\n Turns on node timing. By default, the timers on all nodes are turned on, but if specified with the -name or -type flags,\n only the timers on specified nodes are turned on. The global timers are also turned on by this command. Note that\n turning on timing does NOT reset the timers to zero. Use the -reset flag to reset the timers. The idea for NOT resetting\n the timers is to allow the user to arbitrarily turn timing on and off and continue to add to the existing timer values.\n \n - trace : tr (bool) [create]\n Turns on or off detailed execution tracing. By default, tracing is off. If enabled, each timeable operation is logged\n when it starts and again when it ends. This flag can be used in conjunction with -outputFile to specify where the output\n is generated to. The following example shows how the output is formatted:dgtimer:begin: compute 3 particleShape1Deformed\n particleShape1Deformed.lastPosition The above is an example of the output when -trace is true that marks the start of an\n operation. For specific details on each field: the dgtimer:begin:string is an identifying marker to flag that this is a\n begin operation record. The second argument, computein our example, is the operation metric. You can view the output of\n each given metric via dgtimer -qby specifying the -show flag. The integer which follows (3 in this case) is the depth in\n the operation stack, and the third argument is the name of the node (particleShape1Deformed). The fourth argument is\n specific to the metric. For compute, it gives the name of the plug being computed. For callback, its the internal Maya\n name of the callback. For dirty, its the name of the plug that dirtiness is being propagated from.dgtimer:end: compute 3\n particleShape1Deformed 0.000305685 0.000305685 The above is the end operation record. The compute, 3and\n particleShapeDeformedarguments were described in the dgtimer:beginoverview earlier. The two floating-point arguments are\n self time and inclusive time for the operation measured in seconds. The inclusive measure lists the total time since the\n matching dgtimer:begin:entry for this operation, while the self measure lists the inclusive time minus any time consumed\n by child operations which may have occurred during execution of the current operation. As noted elsewhere in this\n document, these two times are wall clock times, measuring elapsed time including any time in which Maya was idle or\n performing system calls. Since dgtimer can measure some non-node qualities in Maya, such as global message callbacks, a\n -is displayed where the node name would ordinarily be displayed. The -means not applicable.\n \n - type : t (unicode) [create,query]\n Used in conjunction with -reset or -query to specify the type of the node(s) (e.g. animCurveTA) to reset or print timer\n values for. When querying, use of the -combineType flag will cause all nodes of the same type to be combined into one\n entry, and only one line of output is generated (i.e. the global timers and header information is omitted). Note: the\n -name and -type flag cannot be used together.\n \n - uniqueName : un (bool) [create,query]\n Used to specify that the DAG nodes listed in the output should be listed by their unique names. The full DAG path to\n the object will be printed out instead of just the node name.\n \n - updateHeatMap : uhm (int) [create]\n Forces Maya's heat map to rebuild based on the specified parameters. The heat map is an internal dgtimer structure used\n in mapping intensity values to colourmap entries during display by the HyperGraph Editor. There is one heat map shared\n by all editors that are using heat map display mode. Updating the heat map causes the timer values on all nodes to be\n analysed to compose the distribution of entries in the heat map. The parameter is the integer number of divisions in the\n map and should equal the number of available colours for displaying the heat map. This flag can be specified with the\n -rangeLower and -rangeUpper flags to limit the range of displayable to lie between the percentile range. The dgtimer\n command returns the maximum timing value for all nodes in Maya for the specified metric and type. Note: when the display\n range includes 0, the special zeroth (exactly zero) slot in the heat map is avilable.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgtimer`\n "
pass<|docstring|>This command measures dependency graph node performance by managing timers on a per-node basis. Logically, each DG node
has a timer associated with it which records the amount of real time spent in various operations on its plugs. The time
measurement includes the cost of copying data to the node on behalf of the operation, MEL commands executed by an
expression contained in an expression invoked by the node, and includes any wait time such as when a fileTexture node
loads an image file from disk. Most DG operations are reported including compute, draw, and dirty propagation. The
various operations we measure are called metricsand the types of timers are called timer types. The various metrics are
always measured when timing is on, but are only queried when specified via the -show and -hide flags. The metrics
currently supported are listed in detail under the -show flag below. For each metric we support a standard set of timer
types. There are three of these: selffor self time (the time specific to the node and not its children), inclusive(time
including children of the node), and count(number of operations of the given metric on the node). The timing mechanism
which is used by dgtimeris built into the DG itself, thus ALL depend nodes can be timed and there is no need for
programmers writing plug-ins using the OpenMaya API to add any special code in order for their nodes to be timed -- its
all handled transparently. The dgtimercommand allows node timers to be turned on, off, reset to zero, and have their
current value displayed, and these operations can be performed globally on all nodes or on a specific set of nodes
defined by name, type or parentage. Note that all timer measurements are computed in real time(the same time measurement
you get from a wristwatch) as opposed to CPU time(which only measures time when the processor is executing your code).
All times are displayed in seconds. Use the -query flag to display the current timer values on a node, use -on to turn
on timing, use -off to turn off timing, and -reset to reset timers to zero. To display the values measured during
timing, there are two approaches. The first method is to use the -query flag can be used to report the information which
has been measured. The second method is to use the query methods available on the OpenMaya class MFnDependencyNode (see
the OpenMaya documentation for details). What follows is a description of what is generated via -query. The output is
broken out into several sections and these are described as follows: SECTION 1:Section 1 of the dgtimer output contains
global information. This section can be disabled via the -hoHeader flag. These values are reset whenever a global timer
reset occurs (i.e. dgtimer -reset;is specified). The global values which are reported are: Total real time:the total
wall-clock time since the last global timer reset. This is the actual time which has been spent as you might measure it
measure it with your watch. On a multi-processing system, this value will always remain true to to real time (unlike
userand systime).Total user time:the total time the CPU(s) spent processing Maya not including any system time since the
last global timer reset.Total sys time:the total time the CPU(s) spent in operating system calls on behalf of Maya since
the last global timer reset. Summary of each metric for all nodes:a summary of self and count for each metric that we
measure:Real time in callbacksreports the self time and count for the callbackmetric.Real time in computereports the
self time and count for the computemetric.Real time in dirty propagationreports the self time and count for the
dirtymetric.Real time in drawingreports the self time and count for the drawmetric.Real time fetching data from
plugsreports the self time and count for the fetchmetric.Breakdown of select metrics in greater detail:a reporting of
certain combinations of metrics that we measure:Real time in compute invoked from callbackreports the self time spent in
compute when invoked either directly or indirectly by a callback.Real time in compute not invoked from callbackreports
the self time spent in compute not invoked either directly or indirectly by a callback.SECTION 2:Section 2 of the
dgtimer -query output contains per-node information. There is a header which describes the meaning of each column,
followed by the actual per-node data, and this is ultimately followed by a footer which summarises the totals per
column. Note that the data contained in the footer is the global total for each metric and will include any nodes that
have been deleted since the last reset, so the value in the footer MAY exceed what you get when you total the individual
values in the column. To prevent the header and footer from appearing, use the -noHeader flag to just display the per-
node data. The columns which are displayed are as follows: Rank:The order of this node in the sorted list of all nodes,
where the list is sorted by -sortMetric and -sortType flag values (if these are omitted the default is to sort by self
compute time).ON:Tells you if the timer for that node is currently on or off. (With dgtimer, you have the ability to
turn timing on and off on a per-node basis).Per-metric information:various columns are reported for each metric. The
name of the metric is reported at in the header in capital letters (e.g. DRAW). The standard columns for each metric
are:Self:The amount of real time (i.e. elapsed time as you might measure it with a stopwatch) spent performing the
operation (thus if the metric is DRAW, then this will be time spent drawing the node).Inclusive:The amount of real time
(i.e. elapsed time as you might measure it with a stopwatch) spent performing the operation including any child
operations that were invoked on behalf of the operation (thus if the metric is DRAW, then this will be the total time
taken to draw the node including any child operations).Count:The number of operations that occued on this node (thus if
the metric is DRAW, then the number of draw operations on the node will be reported).Sort informationif a column is the
one being used to sort all the per-node dgtimer information, then that column is followed by a Percentand
Cumulativecolumn which describe a running total through the listing. Note that -sortType noneprevents these two columns
from appearing and implicitely sorts on selftime.After the per-metric columns, the node name and type are
reported:TypeThe node type.NameThe name of the node. If the node is file referenced and you are using namespaces, the
namespace will be included. You can also force the dagpath to be displayed by specifying the -uniqueName flag.Plug-in
nameIf the node was implemented in an OpenMaya plug-in, the name of that plug-in is reported.SECTION 3:Section 3 of the
dgtimer -query output describes time spent in callbacks. Note that section 3 only appears when the CALLBACK metric is
shown (see the -show flag). The first part is SECTION 3.1 lists the time per callback with each entry comprising: The
name of the callback, such as attributeChangedMsg. These names are internal Maya names, and in the cases where the
callback is available through the OpenMaya API, the API access to the callback is similarly named.The name is followed
by a breakdown per callbackId. The callbackId is an identifying number which is unique to each client that is registered
to a callback and can be deduced by the user, such as through the OpenMaya API. You can cross-reference by finding the
same callbackId value listed in SECTIONs 3.1 and 3.3.Self time (i.e. real time spent within that callbackId type not
including any child operations which occur while processing the callback).Percent (see the -sortType flag). Note that
the percent values are listed to sum up to 100% for that callback. This is not a global percent.Cumulative (see the
-sortType flag).Inclusive time (i.e. real time spent within that callbackId including any child operations).Count
(number of times the callbackId was invoked).API lists Yif the callbackId was defined through the OpenMaya API, and Nif
the callbackId was defined internally within Maya.Node lists the name of the node this callbackId was associated with.
If the callbackId was associated with more than one node, the string \*multiple\*is printed. If there was no node
associated with the callbackId (or its a callback type in which the node is hard to deduce), the entry is blank.After
the callbackId entries are listed, a dashed line is printed followed by a single line listing the self, inclusive and
count values for the callback. Note that the percent is relative to the global callback time.At the bottom of SECTION
3.1 is the per-column total. The values printed match the summation at the bottom of the listing in section 2. Note that
the values from SECTION 3.1 include any nodes that have been deleted since the last reset. The thresholding parameters
(-threshold, -rangeLower, -rangeUpper and -maxDisplay) are honoured when generating the listing. The sorting of the rows
and display of the Percent and Cumulative columns obeys the -sortType flag. As the listing can be long, zero entries are
not displayed. The second part is SECTION 3.2 which lists the data per callbackId. As noted earlier, the callbackId is
an identifying number which is unique to each client that is registered to a callback and can be deduced by the user,
such as through the OpenMaya API. The entries in SECTION 3.2 appear as follows: CallbackId the numeric identifier for
the callback. You can cross reference by finding the same callbackId value listed in SECTIONs 3.1 and 3.3.For each
callbackId, the data is broken down per-callback:Callback the name of the callback, e.g. attributeChangedMsg.Percent,
Cumulative, Inclusive, Count, API and Node entries as described in SECTION 3.1.After the callback entries are listed for
the callbackId, a dashed followed by a summary line is printed. The summary line lists the self, inclusive and count
values for the callback. Note that the percent is relative to the global callback time.The third part is SECTION 3.3
which lists data per-callback per-node. The nodes are sorted based on the -sortType flag, and for each node, the
callbacks are listed, also sorted based on the -sortType flag. As this listing can be long, zero entries are not
displayed. An important note for SECTION 3.3 is that only nodes which still exist are displayed. If a node has been
deleted, no infromation is listed.
Flags:
- combineType : ct (bool) [query]
Causes all nodes of the same type (e.g. animCurveTA) to be combined in the output display.
- hide : hi (unicode) [create,query]
This flag is the converse of -show. As with -show, it is a query-only flag which can be specified multiple times. If you
do specify -hide, we display all columns except those listed by the -hide flags.
- hierarchy : h (bool) [create,query]
Used to specify that a hierarchy of the dependency graph be affected, thus -reset -hierarchy -name ballwill reset the
timers on the node named balland all of its descendents in the dependency graph.
- maxDisplay : m (int) [query]
Truncates the display so that only the most expenive nentries are printed in the output display.
- name : n (unicode) [create,query]
Used in conjunction with -reset or -query to specify the name of the node to reset or print timer values for. When
querying a single timer, only a single line of output is generated (i.e. the global timers and header information is
omitted). Note that one can force output to the script editor window via the -outputFile MELoption to make it easy to
grab the values in a MEL script. Note: the -name and -type flag cannot be used together.
- noHeader : nh (bool) [create,query]
Used in conjunction with -query to prevent any header or footer information from being printed. All that will be output
is the per-node timing data. This option makes it easier to parse the output such as when you output the query to a file
on disk using the -outputFileoption.
- outputFile : o (unicode) [query]
Specifies where the output of timing or tracing is displayed. The flag takes a string argument which accepts three
possible values: The name of a file on disk.Or the keyword stdout, which causes output to be displayed on the terminal
window (Linux and Macintosh), and the status window on Windows.Or the keyword MEL, which causes output to be displayed
in the Maya Script Editor (only supported with -query).The stdoutsetting is the default behaviour. This flag can be used
with the -query flag as well as the -trace flag. When used with the -trace flag, any tracing output will be displayed on
the destination specified by the -outputFile (or stdout if -outputFile is omitted). Tracing operations will continue to
output to the destination until you specify the -trace and -outputFile flags again. When used with the -query flag,
timing output will be displayed to the destination specified by the -outputFile (or stdoutif -outputFile is omitted).
Here are some examples of how to use the -query, -trace and -outputFile flags: Example: output the timing information to
a single file on disk:dgtimer -on; // Turn on timing create some animated scene
content; play -wait; // Play the scene through dgtimer -query -outputFile
/tmp/timing.txt// Output node timing information to a file on disk Example: output the tracing information to a single
file on disk:dgtimer -on; // Turn on timing create some animated scene content;
dgtimer -trace on -outputFile /tmp/trace.txt// Turn on tracing and output the results to file play -wait;
// Play the scene through; trace info goes to /tmp/trace.txt dgtimer -query; // But
the timing info goes to the terminal window play -wait; // Play the scene again,
trace info still goes to /tmp/trace.txt Example: two runs, outputting the trace information and timing information to
separate files:dgtimer -on; // Turn on timing create some animated scene content;
dgtimer -trace on -outputFile /tmp/trace1.txt// Turn on tracing and output the results to file play -wait;
// Play the scene through dgtimer -query -outputFile /tmp/query1.txt// Output node timing information to another file
dgtimer -reset; dgtimer -trace on -outputFile /tmp/trace2.txt// Output tracing results to different file play -wait;
// Play the scene through dgtimer -query -outputFile /tmp/query2.txt// Output node timing information to another file
Tips and tricks:Outputting the timing results to the script editor makes it easy to use the results in MEL e.g. string
$timing[] = `dgtimer -query -outputFile MEL`.It is important to note that the -outputFile you specify with -trace is
totally independent from the one you specify with -query.If the file you specify already exists, Maya will empty the
file first before outputting data to it (and if the file is not writable, an error is generated instead).
- overhead : oh (bool) [create,query]
Turns on and off the measurement of timing overhead. Under ordinary circumstances the amount of timing overhead is
minimal compared with the events being measured, but in complex scenes, one might find the overhead to be measurable. By
default this option is turned off. To enable it, specify dgtimer -overhead trueprior to starting timing. When querying
timing, the overhead is reported in SECTION 1.2 of the dgtimer output and is not factored out of each individual
operation.
- rangeLower : rgl (float) [create]
This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map
with -updateHeatMap. The value is the lower percentage cutoff for the nodes which are processed. There is also a
-rangeLower flag which sets the lower range limit. The default value is 0, meaning that all nodes with timing value
below the upper range limit are considered.
- rangeUpper : rgu (float) [create]
This flag can be specified to limit the range of nodes which are displayed in a query, or the limits of the heat map
with -updateHeatMap. The value is the upper percentage cutoff for the nodes which are processed. There is also a
-rangeLower flag which sets the lower range limit. The default value is 100, meaning that all nodes with timing value
above the lower range limit are considered.
- reset : r (bool) [create]
Resets the node timers to zero. By default, the timers on all nodes as well as the global timers are reset, but if
specified with the -name or -type flags, only the timers on specified nodes are reset.
- returnCode : rc (unicode) [create,query]
This flag has been replaced by the more general -returnType flag. The -returnCode flag was unfortunately specific to the
compute metric only. It exists only for backwards compatability purposes. It will be removed altogether in a future
release. Here are some handy equivalences: To get the total number of nodes:OLD WAY: dgtimer -rc nodecount -q;//
Result:325//NEW WAY: dgtimer -returnType total -sortType none -q;// Result:325//OLD WAY: dgtimer -rc count -q;//
Result:1270//To get the sum of the compute count column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType
count -q;// Result:1270//OLD WAY: dgtimer -rc selftime -q;// Result:0.112898//To get the sum of the compute self
column:NEW WAY: dgtimer -returnType total -sortMetric compute -sortType self -q;// Result:0.112898//
- returnType : rt (unicode) [query]
This flag specifies what the double value returned by the dgtimer command represents. By default, the value returned is
the global total as displayed in SECTION 1 for the column we are sorting on in the per-node output (the sort column can
be specified via the -sortMetric and -sortType flags). However, instead of the total being returned, the user can
instead request the individual entries for the column. This flag is useful mainly for querying without forcing any
output. The flag accepts the values total, to just display the column total, or allto display all entries individually.
For example, if you want to get the total of draw self time without any other output simply specify the following:
dgtimer -returnType total -sortMetric draw -sortType self -threshold 100 -noHeader -query;// Result: 7718.01 // To
instead get each individual entry, change the above query to: dgtimer -returnType all -sortMetric draw -sortType self
-threshold 100 -noHeader -query;// Result: 6576.01 21.91 11.17 1108.92 // To get the inclusive dirty time for a specific
node, use -name as well as -returnType all: dgtimer -name virginia-returnType all -sortMetric dirty -sortType inclusive
-threshold 100 -noHeader -query;Note: to get the total number of nodes, use -sortType none -returnType total. To get
the on/off status for each node, use -sortType none -returnType all.
- show : sh (unicode) [create,query]
Used in conjunction with -query to specify which columns are to be displayed in the per-node section of the output.
-show takes an argument, which can be all(to display all columns), callback(to display the time spent during any
callback processing on the node not due to evaluation), compute(to display the time spent in the node's compute
methods), dirty(to display time spent propagating dirtiness on behalf of the node), draw(to display time spent drawing
the node), compcb(to display time spent during callback processing on node due to compute), and compncb(to display time
spent during callback processing on node NOT due to compute). The -show flag can be used multiple times, but cannot be
specified with -hide. By default, if neither -show, -hide, or -sort are given, the effective display mode is: dgtimer
-show compute -query.
- sortMetric : sm (unicode) [create,query]
Used in conjunction with -query to specify which metric is to be sorted on when the per-node section of the output is
generated, for example drawtime. Note that the -sortType flag can also be specified to define which timer is sorted on:
for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was
drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortMetric flag can
only be specified at most once. The flag takes the following arguments: callback(to sort on time spent during any
callback processing on the node), compute(to sort on the time spent in the node's compute methods), dirty(to sort on the
time spent propagating dirtiness on behalf of the node), draw(to sort on time spent drawing the node), fetch(to sort on
time spent copying data from the datablock), The default, if -sortMetric is omitted, is to sort on the first displayed
column. Note that the sortMetric is independent of which columns are displayed via -show and -hide. Sort on a hidden
column is allowed. The column selected by -sortMetric and -sortType specifies which total is returned by the dgtimer
command on the MEL command line. This flag is also used with -updateHeatMap to specify which metric to build the heat
map for.
- sortType : st (unicode) [create,query]
Used in conjunction with -query to specify which timer is to be sorted on when the per-node section of the output is
generated, for example selftime. Note that the -sortMetric flag can also be specified to define which metric is sorted
on: for example dgtimer -sortMetric draw -sortType count -querywill sort the output by the number of times each node was
drawn. Both -sortMetric and -sortType are optional and you can specify one without the other. The -sortType flag can be
specified at most once. The flag takes the following arguments: self(to sort on self time, which is the time specific to
the node and not its children), inclusive(to sort on the time including children of the node), count(to sort on the
number of times the node was invoked). and none(to sort on self time, but do not display the Percent and Cumulative
columns in the per-node display, as well as cause the total number of nodes in Maya to be returned on the command line).
The default, if -sortType is omitted, is to sort on self time. The column selected by -sortMetric and -sortType
specifies which total is returned by the dgtimer command on the MEL command line. The global total as displayed in
SECTION 1 of the listing is returned. The special case of -sortType nonecauses the number of nodes in Maya to instead be
returned. This flag is also used with -updateHeatMap to specify which metric to build the heat map for.
- threshold : th (float) [query]
Truncates the display once the value falls below the threshold value. The threshold applies to whatever timer is being
used for sorting. For example, if our sort key is self compute time (i.e. -sortMetric is computeand -sortType is self)
and the threshold parameter is 20.0, then only nodes with a compute self-time of 20.0 or higher will be displayed. (Note
that -threshold uses absolute time. There are the similar -rangeUpper and -rangeLower parameters which specify a range
using percentage).
- timerOff : off (bool) [create,query]
Turns off node timing. By default, the timers on all nodes are turned off, but if specified with the -name or -type
flags, only the timers on specified nodes are turned off. If the timers on all nodes become turned off, then global
timing is also turned off as well.
- timerOn : on (bool) [create,query]
Turns on node timing. By default, the timers on all nodes are turned on, but if specified with the -name or -type flags,
only the timers on specified nodes are turned on. The global timers are also turned on by this command. Note that
turning on timing does NOT reset the timers to zero. Use the -reset flag to reset the timers. The idea for NOT resetting
the timers is to allow the user to arbitrarily turn timing on and off and continue to add to the existing timer values.
- trace : tr (bool) [create]
Turns on or off detailed execution tracing. By default, tracing is off. If enabled, each timeable operation is logged
when it starts and again when it ends. This flag can be used in conjunction with -outputFile to specify where the output
is generated to. The following example shows how the output is formatted:dgtimer:begin: compute 3 particleShape1Deformed
particleShape1Deformed.lastPosition The above is an example of the output when -trace is true that marks the start of an
operation. For specific details on each field: the dgtimer:begin:string is an identifying marker to flag that this is a
begin operation record. The second argument, computein our example, is the operation metric. You can view the output of
each given metric via dgtimer -qby specifying the -show flag. The integer which follows (3 in this case) is the depth in
the operation stack, and the third argument is the name of the node (particleShape1Deformed). The fourth argument is
specific to the metric. For compute, it gives the name of the plug being computed. For callback, its the internal Maya
name of the callback. For dirty, its the name of the plug that dirtiness is being propagated from.dgtimer:end: compute 3
particleShape1Deformed 0.000305685 0.000305685 The above is the end operation record. The compute, 3and
particleShapeDeformedarguments were described in the dgtimer:beginoverview earlier. The two floating-point arguments are
self time and inclusive time for the operation measured in seconds. The inclusive measure lists the total time since the
matching dgtimer:begin:entry for this operation, while the self measure lists the inclusive time minus any time consumed
by child operations which may have occurred during execution of the current operation. As noted elsewhere in this
document, these two times are wall clock times, measuring elapsed time including any time in which Maya was idle or
performing system calls. Since dgtimer can measure some non-node qualities in Maya, such as global message callbacks, a
-is displayed where the node name would ordinarily be displayed. The -means not applicable.
- type : t (unicode) [create,query]
Used in conjunction with -reset or -query to specify the type of the node(s) (e.g. animCurveTA) to reset or print timer
values for. When querying, use of the -combineType flag will cause all nodes of the same type to be combined into one
entry, and only one line of output is generated (i.e. the global timers and header information is omitted). Note: the
-name and -type flag cannot be used together.
- uniqueName : un (bool) [create,query]
Used to specify that the DAG nodes listed in the output should be listed by their unique names. The full DAG path to
the object will be printed out instead of just the node name.
- updateHeatMap : uhm (int) [create]
Forces Maya's heat map to rebuild based on the specified parameters. The heat map is an internal dgtimer structure used
in mapping intensity values to colourmap entries during display by the HyperGraph Editor. There is one heat map shared
by all editors that are using heat map display mode. Updating the heat map causes the timer values on all nodes to be
analysed to compose the distribution of entries in the heat map. The parameter is the integer number of divisions in the
map and should equal the number of available colours for displaying the heat map. This flag can be specified with the
-rangeLower and -rangeUpper flags to limit the range of displayable to lie between the percentile range. The dgtimer
command returns the maximum timing value for all nodes in Maya for the specified metric and type. Note: when the display
range includes 0, the special zeroth (exactly zero) slot in the heat map is avilable.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.dgtimer`<|endoftext|>
|
5c1da690a4a7e1d2407d78cdee8edafde94000821066afd076d6bea88d845c7c
|
def namespaceInfo(*args, **kwargs):
"\n This command displays information about a namespace. The target namespace can optionally be specified on the command\n line. If no namespace is specified, the command will display information about the current namespace. A namespace is a\n simple grouping of objects under a given name. Each item in a namespace can then be identified by its own name, along\n with what namespace it belongs to. Namespaces can contain other namespaces like sets, with the restriction that all\n namespaces are disjoint. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the\n same name as an existing object (from importing a file, for example). Using namespaces, you can have two objects with\n the same name, as long as they are contained in different namespaces. Note that namespaces are a simple grouping of\n names, so they do not effect selection, the DAG, the Dependency Graph, or any other aspect of Maya. All namespace names\n are colon-separated. The namespace format flags are: baseName(shortName), fullNameand absoluteName. The flags are used\n in conjunction with the main query flags to specify the desired namespace format of the returned result. They can also\n be used to return the different formats of a specified namespace. By default, when no format is specified, the result\n will be returned as a full name.\n \n Modifications:\n - returns an empty list when the result is None\n - returns wrapped classes for listOnlyDependencyNodes\n \n Flags:\n - absoluteName : an (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent\n namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not. The absolute namespace name is\n invariant and is not affected by the current namespace or relative namespace modes. See also other format modifiers\n 'baseName', 'fullName', etc\n \n - baseName : bn (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n base name of the namespace contains only the leaf level name and does not contain its parent namespace(s). For example\n the base name of an object named ns:ballis ball. This mode will always return the base name in the same manner, and is\n not affected by the current namespace or relative namespace mode. See also other format modifiers 'absoluteName',\n 'fullName', etc The flag 'shortName' is a synonym for 'baseName'.\n \n - currentNamespace : cur (bool) [create]\n Display the name of the current namespace.\n \n - dagPath : dp (bool) [create]\n This flag modifies the 'listNamespace' and 'listOnlyDependencyNodes' flags to indicate that the names of any dag objects\n returned will include as much of the dag path as is necessary to make the names unique. If this flag is not present, the\n names returned will not include any dag paths.\n \n - fullName : fn (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n full name of the namespace contains both the namespace path and the base name, but without the leading colon\n representing the root namespace. For example ns:ballis a full name, whereas :ns:ballis an absolute name. This mode is\n affected by the current namespace and relative namespace modes. See also other format modifiers 'baseName',\n 'absoluteName', etc.\n \n - internal : int (bool) [create]\n This flag is used together with the 'listOnlyDependencyNodes' flag. When this flag is set, the returned list will\n include internal nodes (for example itemFilters) that are not listed by default.\n \n - isRootNamespace : ir (unicode) [create]\n Returns true if the namespace is root(:), false if not.\n \n - listNamespace : ls (bool) [create]\n List the contents of the namespace.\n \n - listOnlyDependencyNodes : lod (bool) [create]\n List all dependency nodes in the namespace.\n \n - listOnlyNamespaces : lon (bool) [create]\n List all namespaces in the namespace.\n \n - parent : p (bool) [create]\n Display the parent of the namespace. By default, the list returned will not include internal nodes (such as\n itemFilters). To include the internal nodes, use the 'internal' flag.\n \n - recurse : r (bool) [create]\n Can be specified with 'listNamespace', 'listOnlyNamespaces' or 'listOnlyDependencyNode' to cause the listing to\n recursively include any child namespaces of the namespaces;\n \n - shortName : sn (bool) [create]\n This flag is deprecated and may be removed in future releases of Maya. It is a synonym for the baseName flag. Please use\n the baseName flag instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.namespaceInfo`\n "
pass
|
This command displays information about a namespace. The target namespace can optionally be specified on the command
line. If no namespace is specified, the command will display information about the current namespace. A namespace is a
simple grouping of objects under a given name. Each item in a namespace can then be identified by its own name, along
with what namespace it belongs to. Namespaces can contain other namespaces like sets, with the restriction that all
namespaces are disjoint. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the
same name as an existing object (from importing a file, for example). Using namespaces, you can have two objects with
the same name, as long as they are contained in different namespaces. Note that namespaces are a simple grouping of
names, so they do not effect selection, the DAG, the Dependency Graph, or any other aspect of Maya. All namespace names
are colon-separated. The namespace format flags are: baseName(shortName), fullNameand absoluteName. The flags are used
in conjunction with the main query flags to specify the desired namespace format of the returned result. They can also
be used to return the different formats of a specified namespace. By default, when no format is specified, the result
will be returned as a full name.
Modifications:
- returns an empty list when the result is None
- returns wrapped classes for listOnlyDependencyNodes
Flags:
- absoluteName : an (bool) [create]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent
namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not. The absolute namespace name is
invariant and is not affected by the current namespace or relative namespace modes. See also other format modifiers
'baseName', 'fullName', etc
- baseName : bn (bool) [create]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
base name of the namespace contains only the leaf level name and does not contain its parent namespace(s). For example
the base name of an object named ns:ballis ball. This mode will always return the base name in the same manner, and is
not affected by the current namespace or relative namespace mode. See also other format modifiers 'absoluteName',
'fullName', etc The flag 'shortName' is a synonym for 'baseName'.
- currentNamespace : cur (bool) [create]
Display the name of the current namespace.
- dagPath : dp (bool) [create]
This flag modifies the 'listNamespace' and 'listOnlyDependencyNodes' flags to indicate that the names of any dag objects
returned will include as much of the dag path as is necessary to make the names unique. If this flag is not present, the
names returned will not include any dag paths.
- fullName : fn (bool) [create]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
full name of the namespace contains both the namespace path and the base name, but without the leading colon
representing the root namespace. For example ns:ballis a full name, whereas :ns:ballis an absolute name. This mode is
affected by the current namespace and relative namespace modes. See also other format modifiers 'baseName',
'absoluteName', etc.
- internal : int (bool) [create]
This flag is used together with the 'listOnlyDependencyNodes' flag. When this flag is set, the returned list will
include internal nodes (for example itemFilters) that are not listed by default.
- isRootNamespace : ir (unicode) [create]
Returns true if the namespace is root(:), false if not.
- listNamespace : ls (bool) [create]
List the contents of the namespace.
- listOnlyDependencyNodes : lod (bool) [create]
List all dependency nodes in the namespace.
- listOnlyNamespaces : lon (bool) [create]
List all namespaces in the namespace.
- parent : p (bool) [create]
Display the parent of the namespace. By default, the list returned will not include internal nodes (such as
itemFilters). To include the internal nodes, use the 'internal' flag.
- recurse : r (bool) [create]
Can be specified with 'listNamespace', 'listOnlyNamespaces' or 'listOnlyDependencyNode' to cause the listing to
recursively include any child namespaces of the namespaces;
- shortName : sn (bool) [create]
This flag is deprecated and may be removed in future releases of Maya. It is a synonym for the baseName flag. Please use
the baseName flag instead. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.namespaceInfo`
|
mayaSDK/pymel/core/system.py
|
namespaceInfo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def namespaceInfo(*args, **kwargs):
"\n This command displays information about a namespace. The target namespace can optionally be specified on the command\n line. If no namespace is specified, the command will display information about the current namespace. A namespace is a\n simple grouping of objects under a given name. Each item in a namespace can then be identified by its own name, along\n with what namespace it belongs to. Namespaces can contain other namespaces like sets, with the restriction that all\n namespaces are disjoint. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the\n same name as an existing object (from importing a file, for example). Using namespaces, you can have two objects with\n the same name, as long as they are contained in different namespaces. Note that namespaces are a simple grouping of\n names, so they do not effect selection, the DAG, the Dependency Graph, or any other aspect of Maya. All namespace names\n are colon-separated. The namespace format flags are: baseName(shortName), fullNameand absoluteName. The flags are used\n in conjunction with the main query flags to specify the desired namespace format of the returned result. They can also\n be used to return the different formats of a specified namespace. By default, when no format is specified, the result\n will be returned as a full name.\n \n Modifications:\n - returns an empty list when the result is None\n - returns wrapped classes for listOnlyDependencyNodes\n \n Flags:\n - absoluteName : an (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent\n namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not. The absolute namespace name is\n invariant and is not affected by the current namespace or relative namespace modes. See also other format modifiers\n 'baseName', 'fullName', etc\n \n - baseName : bn (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n base name of the namespace contains only the leaf level name and does not contain its parent namespace(s). For example\n the base name of an object named ns:ballis ball. This mode will always return the base name in the same manner, and is\n not affected by the current namespace or relative namespace mode. See also other format modifiers 'absoluteName',\n 'fullName', etc The flag 'shortName' is a synonym for 'baseName'.\n \n - currentNamespace : cur (bool) [create]\n Display the name of the current namespace.\n \n - dagPath : dp (bool) [create]\n This flag modifies the 'listNamespace' and 'listOnlyDependencyNodes' flags to indicate that the names of any dag objects\n returned will include as much of the dag path as is necessary to make the names unique. If this flag is not present, the\n names returned will not include any dag paths.\n \n - fullName : fn (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n full name of the namespace contains both the namespace path and the base name, but without the leading colon\n representing the root namespace. For example ns:ballis a full name, whereas :ns:ballis an absolute name. This mode is\n affected by the current namespace and relative namespace modes. See also other format modifiers 'baseName',\n 'absoluteName', etc.\n \n - internal : int (bool) [create]\n This flag is used together with the 'listOnlyDependencyNodes' flag. When this flag is set, the returned list will\n include internal nodes (for example itemFilters) that are not listed by default.\n \n - isRootNamespace : ir (unicode) [create]\n Returns true if the namespace is root(:), false if not.\n \n - listNamespace : ls (bool) [create]\n List the contents of the namespace.\n \n - listOnlyDependencyNodes : lod (bool) [create]\n List all dependency nodes in the namespace.\n \n - listOnlyNamespaces : lon (bool) [create]\n List all namespaces in the namespace.\n \n - parent : p (bool) [create]\n Display the parent of the namespace. By default, the list returned will not include internal nodes (such as\n itemFilters). To include the internal nodes, use the 'internal' flag.\n \n - recurse : r (bool) [create]\n Can be specified with 'listNamespace', 'listOnlyNamespaces' or 'listOnlyDependencyNode' to cause the listing to\n recursively include any child namespaces of the namespaces;\n \n - shortName : sn (bool) [create]\n This flag is deprecated and may be removed in future releases of Maya. It is a synonym for the baseName flag. Please use\n the baseName flag instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.namespaceInfo`\n "
pass
|
def namespaceInfo(*args, **kwargs):
"\n This command displays information about a namespace. The target namespace can optionally be specified on the command\n line. If no namespace is specified, the command will display information about the current namespace. A namespace is a\n simple grouping of objects under a given name. Each item in a namespace can then be identified by its own name, along\n with what namespace it belongs to. Namespaces can contain other namespaces like sets, with the restriction that all\n namespaces are disjoint. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the\n same name as an existing object (from importing a file, for example). Using namespaces, you can have two objects with\n the same name, as long as they are contained in different namespaces. Note that namespaces are a simple grouping of\n names, so they do not effect selection, the DAG, the Dependency Graph, or any other aspect of Maya. All namespace names\n are colon-separated. The namespace format flags are: baseName(shortName), fullNameand absoluteName. The flags are used\n in conjunction with the main query flags to specify the desired namespace format of the returned result. They can also\n be used to return the different formats of a specified namespace. By default, when no format is specified, the result\n will be returned as a full name.\n \n Modifications:\n - returns an empty list when the result is None\n - returns wrapped classes for listOnlyDependencyNodes\n \n Flags:\n - absoluteName : an (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent\n namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not. The absolute namespace name is\n invariant and is not affected by the current namespace or relative namespace modes. See also other format modifiers\n 'baseName', 'fullName', etc\n \n - baseName : bn (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n base name of the namespace contains only the leaf level name and does not contain its parent namespace(s). For example\n the base name of an object named ns:ballis ball. This mode will always return the base name in the same manner, and is\n not affected by the current namespace or relative namespace mode. See also other format modifiers 'absoluteName',\n 'fullName', etc The flag 'shortName' is a synonym for 'baseName'.\n \n - currentNamespace : cur (bool) [create]\n Display the name of the current namespace.\n \n - dagPath : dp (bool) [create]\n This flag modifies the 'listNamespace' and 'listOnlyDependencyNodes' flags to indicate that the names of any dag objects\n returned will include as much of the dag path as is necessary to make the names unique. If this flag is not present, the\n names returned will not include any dag paths.\n \n - fullName : fn (bool) [create]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n full name of the namespace contains both the namespace path and the base name, but without the leading colon\n representing the root namespace. For example ns:ballis a full name, whereas :ns:ballis an absolute name. This mode is\n affected by the current namespace and relative namespace modes. See also other format modifiers 'baseName',\n 'absoluteName', etc.\n \n - internal : int (bool) [create]\n This flag is used together with the 'listOnlyDependencyNodes' flag. When this flag is set, the returned list will\n include internal nodes (for example itemFilters) that are not listed by default.\n \n - isRootNamespace : ir (unicode) [create]\n Returns true if the namespace is root(:), false if not.\n \n - listNamespace : ls (bool) [create]\n List the contents of the namespace.\n \n - listOnlyDependencyNodes : lod (bool) [create]\n List all dependency nodes in the namespace.\n \n - listOnlyNamespaces : lon (bool) [create]\n List all namespaces in the namespace.\n \n - parent : p (bool) [create]\n Display the parent of the namespace. By default, the list returned will not include internal nodes (such as\n itemFilters). To include the internal nodes, use the 'internal' flag.\n \n - recurse : r (bool) [create]\n Can be specified with 'listNamespace', 'listOnlyNamespaces' or 'listOnlyDependencyNode' to cause the listing to\n recursively include any child namespaces of the namespaces;\n \n - shortName : sn (bool) [create]\n This flag is deprecated and may be removed in future releases of Maya. It is a synonym for the baseName flag. Please use\n the baseName flag instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.namespaceInfo`\n "
pass<|docstring|>This command displays information about a namespace. The target namespace can optionally be specified on the command
line. If no namespace is specified, the command will display information about the current namespace. A namespace is a
simple grouping of objects under a given name. Each item in a namespace can then be identified by its own name, along
with what namespace it belongs to. Namespaces can contain other namespaces like sets, with the restriction that all
namespaces are disjoint. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the
same name as an existing object (from importing a file, for example). Using namespaces, you can have two objects with
the same name, as long as they are contained in different namespaces. Note that namespaces are a simple grouping of
names, so they do not effect selection, the DAG, the Dependency Graph, or any other aspect of Maya. All namespace names
are colon-separated. The namespace format flags are: baseName(shortName), fullNameand absoluteName. The flags are used
in conjunction with the main query flags to specify the desired namespace format of the returned result. They can also
be used to return the different formats of a specified namespace. By default, when no format is specified, the result
will be returned as a full name.
Modifications:
- returns an empty list when the result is None
- returns wrapped classes for listOnlyDependencyNodes
Flags:
- absoluteName : an (bool) [create]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent
namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not. The absolute namespace name is
invariant and is not affected by the current namespace or relative namespace modes. See also other format modifiers
'baseName', 'fullName', etc
- baseName : bn (bool) [create]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
base name of the namespace contains only the leaf level name and does not contain its parent namespace(s). For example
the base name of an object named ns:ballis ball. This mode will always return the base name in the same manner, and is
not affected by the current namespace or relative namespace mode. See also other format modifiers 'absoluteName',
'fullName', etc The flag 'shortName' is a synonym for 'baseName'.
- currentNamespace : cur (bool) [create]
Display the name of the current namespace.
- dagPath : dp (bool) [create]
This flag modifies the 'listNamespace' and 'listOnlyDependencyNodes' flags to indicate that the names of any dag objects
returned will include as much of the dag path as is necessary to make the names unique. If this flag is not present, the
names returned will not include any dag paths.
- fullName : fn (bool) [create]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
full name of the namespace contains both the namespace path and the base name, but without the leading colon
representing the root namespace. For example ns:ballis a full name, whereas :ns:ballis an absolute name. This mode is
affected by the current namespace and relative namespace modes. See also other format modifiers 'baseName',
'absoluteName', etc.
- internal : int (bool) [create]
This flag is used together with the 'listOnlyDependencyNodes' flag. When this flag is set, the returned list will
include internal nodes (for example itemFilters) that are not listed by default.
- isRootNamespace : ir (unicode) [create]
Returns true if the namespace is root(:), false if not.
- listNamespace : ls (bool) [create]
List the contents of the namespace.
- listOnlyDependencyNodes : lod (bool) [create]
List all dependency nodes in the namespace.
- listOnlyNamespaces : lon (bool) [create]
List all namespaces in the namespace.
- parent : p (bool) [create]
Display the parent of the namespace. By default, the list returned will not include internal nodes (such as
itemFilters). To include the internal nodes, use the 'internal' flag.
- recurse : r (bool) [create]
Can be specified with 'listNamespace', 'listOnlyNamespaces' or 'listOnlyDependencyNode' to cause the listing to
recursively include any child namespaces of the namespaces;
- shortName : sn (bool) [create]
This flag is deprecated and may be removed in future releases of Maya. It is a synonym for the baseName flag. Please use
the baseName flag instead. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.namespaceInfo`<|endoftext|>
|
d87c1d26b4255a37ffade170b91a243168e83c4b42ba85815e98f81b408f16a7
|
def convertUnit(*args, **kwargs):
'\n This command converts values between different units of measure. The command takes a string, because a string can\n incorporate unit names as well as values (see examples).\n \n Flags:\n - fromUnit : f (unicode) [create]\n The unit to convert from. If not supplied, it is assumed to be the system default. The from unit may also be supplied\n as part of the value e.g. 11.2m (11.2 meters).\n \n - toUnit : t (unicode) [create]\n The unit to convert to. If not supplied, it is assumed to be the system default Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.convertUnit`\n '
pass
|
This command converts values between different units of measure. The command takes a string, because a string can
incorporate unit names as well as values (see examples).
Flags:
- fromUnit : f (unicode) [create]
The unit to convert from. If not supplied, it is assumed to be the system default. The from unit may also be supplied
as part of the value e.g. 11.2m (11.2 meters).
- toUnit : t (unicode) [create]
The unit to convert to. If not supplied, it is assumed to be the system default Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.convertUnit`
|
mayaSDK/pymel/core/system.py
|
convertUnit
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def convertUnit(*args, **kwargs):
'\n This command converts values between different units of measure. The command takes a string, because a string can\n incorporate unit names as well as values (see examples).\n \n Flags:\n - fromUnit : f (unicode) [create]\n The unit to convert from. If not supplied, it is assumed to be the system default. The from unit may also be supplied\n as part of the value e.g. 11.2m (11.2 meters).\n \n - toUnit : t (unicode) [create]\n The unit to convert to. If not supplied, it is assumed to be the system default Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.convertUnit`\n '
pass
|
def convertUnit(*args, **kwargs):
'\n This command converts values between different units of measure. The command takes a string, because a string can\n incorporate unit names as well as values (see examples).\n \n Flags:\n - fromUnit : f (unicode) [create]\n The unit to convert from. If not supplied, it is assumed to be the system default. The from unit may also be supplied\n as part of the value e.g. 11.2m (11.2 meters).\n \n - toUnit : t (unicode) [create]\n The unit to convert to. If not supplied, it is assumed to be the system default Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.convertUnit`\n '
pass<|docstring|>This command converts values between different units of measure. The command takes a string, because a string can
incorporate unit names as well as values (see examples).
Flags:
- fromUnit : f (unicode) [create]
The unit to convert from. If not supplied, it is assumed to be the system default. The from unit may also be supplied
as part of the value e.g. 11.2m (11.2 meters).
- toUnit : t (unicode) [create]
The unit to convert to. If not supplied, it is assumed to be the system default Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.convertUnit`<|endoftext|>
|
50cbfbb8e8bfa3083a725e2c7b9deabdb818746c25db9690e1d888febef78dbb
|
def loadPlugin(*args, **kwargs):
"\n Load plug-ins into Maya. The parameter(s) to this command are either the names or pathnames of plug-in files. The\n convention for naming plug-ins is to use a .so extension on Linux, a .mll extension on Windows and .bundle extension on\n Mac OS X. If no extension is provided then the default extension for the platform will be used. To load a Python plugin\n you must explicitly supply the '.py' extension. If the plugin was specified with a pathname then that is where the\n plugin will be searched for. If no pathname was provided then the current working directory (i.e. the one returned by\n Maya's 'pwd' command) will be searched, followed by the directories in the MAYA_PLUG_IN_PATH environment variable. When\n the plug-in is loaded, the name used in Maya's internal plug-in registry for the plug-in information will be the file\n name with the extension removed. For example, if you load the plug-in newNode.mllthe name used in the Maya's registry\n will be newNode. This value as well as that value with either a .so, .mllor .bundleextension can be used as valid\n arguments to either the unloadPlugin or pluginInfo commands.\n \n Flags:\n - addCallback : ac (script) [create]\n Add a MEL or Python callback script to be called after a plug-in is loaded. For MEL, the procedure should have the\n following signature: global proc procedureName(string $pluginName). For Python, you may specify either a script as a\n string, or a Python callable object such as a function. If you specify a string, then put the formatting specifier\n %swhere you want the name of the plug-in to be inserted. If you specify a callable such as a function, then the name of\n the plug-in will be passed as an argument.\n \n - allPlugins : a (bool) [create]\n Cause all plug-ins in the search path specified in MAYA_PLUG_IN_PATH to be loaded.\n \n - name : n (unicode) [create]\n Set a user defined name for the plug-ins that are loaded. If the name is already taken, then a number will be added to\n the end of the name to make it unique.\n \n - qObsolete : q (bool) []\n \n - quiet : qt (bool) [create]\n Don't print a warning if you attempt to load a plug-in that is already loaded.\n \n - removeCallback : rc (script) [create]\n Removes a procedure which was previously added with -addCallback. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.loadPlugin`\n "
pass
|
Load plug-ins into Maya. The parameter(s) to this command are either the names or pathnames of plug-in files. The
convention for naming plug-ins is to use a .so extension on Linux, a .mll extension on Windows and .bundle extension on
Mac OS X. If no extension is provided then the default extension for the platform will be used. To load a Python plugin
you must explicitly supply the '.py' extension. If the plugin was specified with a pathname then that is where the
plugin will be searched for. If no pathname was provided then the current working directory (i.e. the one returned by
Maya's 'pwd' command) will be searched, followed by the directories in the MAYA_PLUG_IN_PATH environment variable. When
the plug-in is loaded, the name used in Maya's internal plug-in registry for the plug-in information will be the file
name with the extension removed. For example, if you load the plug-in newNode.mllthe name used in the Maya's registry
will be newNode. This value as well as that value with either a .so, .mllor .bundleextension can be used as valid
arguments to either the unloadPlugin or pluginInfo commands.
Flags:
- addCallback : ac (script) [create]
Add a MEL or Python callback script to be called after a plug-in is loaded. For MEL, the procedure should have the
following signature: global proc procedureName(string $pluginName). For Python, you may specify either a script as a
string, or a Python callable object such as a function. If you specify a string, then put the formatting specifier
%swhere you want the name of the plug-in to be inserted. If you specify a callable such as a function, then the name of
the plug-in will be passed as an argument.
- allPlugins : a (bool) [create]
Cause all plug-ins in the search path specified in MAYA_PLUG_IN_PATH to be loaded.
- name : n (unicode) [create]
Set a user defined name for the plug-ins that are loaded. If the name is already taken, then a number will be added to
the end of the name to make it unique.
- qObsolete : q (bool) []
- quiet : qt (bool) [create]
Don't print a warning if you attempt to load a plug-in that is already loaded.
- removeCallback : rc (script) [create]
Removes a procedure which was previously added with -addCallback. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.loadPlugin`
|
mayaSDK/pymel/core/system.py
|
loadPlugin
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def loadPlugin(*args, **kwargs):
"\n Load plug-ins into Maya. The parameter(s) to this command are either the names or pathnames of plug-in files. The\n convention for naming plug-ins is to use a .so extension on Linux, a .mll extension on Windows and .bundle extension on\n Mac OS X. If no extension is provided then the default extension for the platform will be used. To load a Python plugin\n you must explicitly supply the '.py' extension. If the plugin was specified with a pathname then that is where the\n plugin will be searched for. If no pathname was provided then the current working directory (i.e. the one returned by\n Maya's 'pwd' command) will be searched, followed by the directories in the MAYA_PLUG_IN_PATH environment variable. When\n the plug-in is loaded, the name used in Maya's internal plug-in registry for the plug-in information will be the file\n name with the extension removed. For example, if you load the plug-in newNode.mllthe name used in the Maya's registry\n will be newNode. This value as well as that value with either a .so, .mllor .bundleextension can be used as valid\n arguments to either the unloadPlugin or pluginInfo commands.\n \n Flags:\n - addCallback : ac (script) [create]\n Add a MEL or Python callback script to be called after a plug-in is loaded. For MEL, the procedure should have the\n following signature: global proc procedureName(string $pluginName). For Python, you may specify either a script as a\n string, or a Python callable object such as a function. If you specify a string, then put the formatting specifier\n %swhere you want the name of the plug-in to be inserted. If you specify a callable such as a function, then the name of\n the plug-in will be passed as an argument.\n \n - allPlugins : a (bool) [create]\n Cause all plug-ins in the search path specified in MAYA_PLUG_IN_PATH to be loaded.\n \n - name : n (unicode) [create]\n Set a user defined name for the plug-ins that are loaded. If the name is already taken, then a number will be added to\n the end of the name to make it unique.\n \n - qObsolete : q (bool) []\n \n - quiet : qt (bool) [create]\n Don't print a warning if you attempt to load a plug-in that is already loaded.\n \n - removeCallback : rc (script) [create]\n Removes a procedure which was previously added with -addCallback. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.loadPlugin`\n "
pass
|
def loadPlugin(*args, **kwargs):
"\n Load plug-ins into Maya. The parameter(s) to this command are either the names or pathnames of plug-in files. The\n convention for naming plug-ins is to use a .so extension on Linux, a .mll extension on Windows and .bundle extension on\n Mac OS X. If no extension is provided then the default extension for the platform will be used. To load a Python plugin\n you must explicitly supply the '.py' extension. If the plugin was specified with a pathname then that is where the\n plugin will be searched for. If no pathname was provided then the current working directory (i.e. the one returned by\n Maya's 'pwd' command) will be searched, followed by the directories in the MAYA_PLUG_IN_PATH environment variable. When\n the plug-in is loaded, the name used in Maya's internal plug-in registry for the plug-in information will be the file\n name with the extension removed. For example, if you load the plug-in newNode.mllthe name used in the Maya's registry\n will be newNode. This value as well as that value with either a .so, .mllor .bundleextension can be used as valid\n arguments to either the unloadPlugin or pluginInfo commands.\n \n Flags:\n - addCallback : ac (script) [create]\n Add a MEL or Python callback script to be called after a plug-in is loaded. For MEL, the procedure should have the\n following signature: global proc procedureName(string $pluginName). For Python, you may specify either a script as a\n string, or a Python callable object such as a function. If you specify a string, then put the formatting specifier\n %swhere you want the name of the plug-in to be inserted. If you specify a callable such as a function, then the name of\n the plug-in will be passed as an argument.\n \n - allPlugins : a (bool) [create]\n Cause all plug-ins in the search path specified in MAYA_PLUG_IN_PATH to be loaded.\n \n - name : n (unicode) [create]\n Set a user defined name for the plug-ins that are loaded. If the name is already taken, then a number will be added to\n the end of the name to make it unique.\n \n - qObsolete : q (bool) []\n \n - quiet : qt (bool) [create]\n Don't print a warning if you attempt to load a plug-in that is already loaded.\n \n - removeCallback : rc (script) [create]\n Removes a procedure which was previously added with -addCallback. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.loadPlugin`\n "
pass<|docstring|>Load plug-ins into Maya. The parameter(s) to this command are either the names or pathnames of plug-in files. The
convention for naming plug-ins is to use a .so extension on Linux, a .mll extension on Windows and .bundle extension on
Mac OS X. If no extension is provided then the default extension for the platform will be used. To load a Python plugin
you must explicitly supply the '.py' extension. If the plugin was specified with a pathname then that is where the
plugin will be searched for. If no pathname was provided then the current working directory (i.e. the one returned by
Maya's 'pwd' command) will be searched, followed by the directories in the MAYA_PLUG_IN_PATH environment variable. When
the plug-in is loaded, the name used in Maya's internal plug-in registry for the plug-in information will be the file
name with the extension removed. For example, if you load the plug-in newNode.mllthe name used in the Maya's registry
will be newNode. This value as well as that value with either a .so, .mllor .bundleextension can be used as valid
arguments to either the unloadPlugin or pluginInfo commands.
Flags:
- addCallback : ac (script) [create]
Add a MEL or Python callback script to be called after a plug-in is loaded. For MEL, the procedure should have the
following signature: global proc procedureName(string $pluginName). For Python, you may specify either a script as a
string, or a Python callable object such as a function. If you specify a string, then put the formatting specifier
%swhere you want the name of the plug-in to be inserted. If you specify a callable such as a function, then the name of
the plug-in will be passed as an argument.
- allPlugins : a (bool) [create]
Cause all plug-ins in the search path specified in MAYA_PLUG_IN_PATH to be loaded.
- name : n (unicode) [create]
Set a user defined name for the plug-ins that are loaded. If the name is already taken, then a number will be added to
the end of the name to make it unique.
- qObsolete : q (bool) []
- quiet : qt (bool) [create]
Don't print a warning if you attempt to load a plug-in that is already loaded.
- removeCallback : rc (script) [create]
Removes a procedure which was previously added with -addCallback. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.loadPlugin`<|endoftext|>
|
f24c282b809b0617c5ca5e03b1856df79568b1bbbf9eb22a515091558534b27d
|
def memory(*args, **kwargs):
"\n Used to query essential statistics on memory availability and usage. By default memory sizes are returned in bytes.\n Since Maya's command engine only supports 32-bit signed integers, any returned value which cannot fit into 31 bits will\n be truncated to 2,147,483,647 and a warning message displayed. To avoid having memory sizes truncated use one of the\n memory size flags to return the value in larger units (e.g. megabytes) or use the asFloat flag to return the value as a\n float.\n \n Flags:\n - asFloat : af (bool) [create]\n Causes numeric values to be returned as floats rather than ints. This can be useful if you wish to retain some of the\n significant digits lost when using the unit size flags.\n \n - debug : dbg (bool) []\n \n - freeMemory : fr (bool) [create]\n Returns size of free memory\n \n - gigaByte : gb (bool) [create]\n Return memory sizes in gigabytes (1024\\*1024\\*1024 bytes)\n \n - heapMemory : he (bool) [create]\n Returns size of memory heap\n \n - kiloByte : kb (bool) [create]\n Return memory sizes in kilobytes (1024 bytes)\n \n - megaByte : mb (bool) [create]\n Return memory sizes in megabytes (1024\\*1024 bytes)\n \n - pageFaults : pf (bool) [create]\n Returns number of page faults\n \n - pageReclaims : pr (bool) [create]\n Returns number of page reclaims\n \n - physicalMemory : phy (bool) [create]\n Returns size of physical memory\n \n - summary : sum (bool) [create]\n Returns a summary of memory usage. The size flags are ignored and all memory sizes are given in megabytes.\n \n - swapFree : swf (bool) [create]\n Returns size of free swap\n \n - swapLogical : swl (bool) [create]\n Returns size of logical swap\n \n - swapMax : swm (bool) [create]\n Returns maximum swap size\n \n - swapPhysical : swp (bool) [create]\n Returns size of physical swap\n \n - swapReserved : swr (bool) []\n \n - swapVirtual : swv (bool) [create]\n Returns size of virtual swap\n \n - swaps : sw (bool) [create]\n Returns number of swaps Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.memory`\n "
pass
|
Used to query essential statistics on memory availability and usage. By default memory sizes are returned in bytes.
Since Maya's command engine only supports 32-bit signed integers, any returned value which cannot fit into 31 bits will
be truncated to 2,147,483,647 and a warning message displayed. To avoid having memory sizes truncated use one of the
memory size flags to return the value in larger units (e.g. megabytes) or use the asFloat flag to return the value as a
float.
Flags:
- asFloat : af (bool) [create]
Causes numeric values to be returned as floats rather than ints. This can be useful if you wish to retain some of the
significant digits lost when using the unit size flags.
- debug : dbg (bool) []
- freeMemory : fr (bool) [create]
Returns size of free memory
- gigaByte : gb (bool) [create]
Return memory sizes in gigabytes (1024\*1024\*1024 bytes)
- heapMemory : he (bool) [create]
Returns size of memory heap
- kiloByte : kb (bool) [create]
Return memory sizes in kilobytes (1024 bytes)
- megaByte : mb (bool) [create]
Return memory sizes in megabytes (1024\*1024 bytes)
- pageFaults : pf (bool) [create]
Returns number of page faults
- pageReclaims : pr (bool) [create]
Returns number of page reclaims
- physicalMemory : phy (bool) [create]
Returns size of physical memory
- summary : sum (bool) [create]
Returns a summary of memory usage. The size flags are ignored and all memory sizes are given in megabytes.
- swapFree : swf (bool) [create]
Returns size of free swap
- swapLogical : swl (bool) [create]
Returns size of logical swap
- swapMax : swm (bool) [create]
Returns maximum swap size
- swapPhysical : swp (bool) [create]
Returns size of physical swap
- swapReserved : swr (bool) []
- swapVirtual : swv (bool) [create]
Returns size of virtual swap
- swaps : sw (bool) [create]
Returns number of swaps Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.memory`
|
mayaSDK/pymel/core/system.py
|
memory
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def memory(*args, **kwargs):
"\n Used to query essential statistics on memory availability and usage. By default memory sizes are returned in bytes.\n Since Maya's command engine only supports 32-bit signed integers, any returned value which cannot fit into 31 bits will\n be truncated to 2,147,483,647 and a warning message displayed. To avoid having memory sizes truncated use one of the\n memory size flags to return the value in larger units (e.g. megabytes) or use the asFloat flag to return the value as a\n float.\n \n Flags:\n - asFloat : af (bool) [create]\n Causes numeric values to be returned as floats rather than ints. This can be useful if you wish to retain some of the\n significant digits lost when using the unit size flags.\n \n - debug : dbg (bool) []\n \n - freeMemory : fr (bool) [create]\n Returns size of free memory\n \n - gigaByte : gb (bool) [create]\n Return memory sizes in gigabytes (1024\\*1024\\*1024 bytes)\n \n - heapMemory : he (bool) [create]\n Returns size of memory heap\n \n - kiloByte : kb (bool) [create]\n Return memory sizes in kilobytes (1024 bytes)\n \n - megaByte : mb (bool) [create]\n Return memory sizes in megabytes (1024\\*1024 bytes)\n \n - pageFaults : pf (bool) [create]\n Returns number of page faults\n \n - pageReclaims : pr (bool) [create]\n Returns number of page reclaims\n \n - physicalMemory : phy (bool) [create]\n Returns size of physical memory\n \n - summary : sum (bool) [create]\n Returns a summary of memory usage. The size flags are ignored and all memory sizes are given in megabytes.\n \n - swapFree : swf (bool) [create]\n Returns size of free swap\n \n - swapLogical : swl (bool) [create]\n Returns size of logical swap\n \n - swapMax : swm (bool) [create]\n Returns maximum swap size\n \n - swapPhysical : swp (bool) [create]\n Returns size of physical swap\n \n - swapReserved : swr (bool) []\n \n - swapVirtual : swv (bool) [create]\n Returns size of virtual swap\n \n - swaps : sw (bool) [create]\n Returns number of swaps Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.memory`\n "
pass
|
def memory(*args, **kwargs):
"\n Used to query essential statistics on memory availability and usage. By default memory sizes are returned in bytes.\n Since Maya's command engine only supports 32-bit signed integers, any returned value which cannot fit into 31 bits will\n be truncated to 2,147,483,647 and a warning message displayed. To avoid having memory sizes truncated use one of the\n memory size flags to return the value in larger units (e.g. megabytes) or use the asFloat flag to return the value as a\n float.\n \n Flags:\n - asFloat : af (bool) [create]\n Causes numeric values to be returned as floats rather than ints. This can be useful if you wish to retain some of the\n significant digits lost when using the unit size flags.\n \n - debug : dbg (bool) []\n \n - freeMemory : fr (bool) [create]\n Returns size of free memory\n \n - gigaByte : gb (bool) [create]\n Return memory sizes in gigabytes (1024\\*1024\\*1024 bytes)\n \n - heapMemory : he (bool) [create]\n Returns size of memory heap\n \n - kiloByte : kb (bool) [create]\n Return memory sizes in kilobytes (1024 bytes)\n \n - megaByte : mb (bool) [create]\n Return memory sizes in megabytes (1024\\*1024 bytes)\n \n - pageFaults : pf (bool) [create]\n Returns number of page faults\n \n - pageReclaims : pr (bool) [create]\n Returns number of page reclaims\n \n - physicalMemory : phy (bool) [create]\n Returns size of physical memory\n \n - summary : sum (bool) [create]\n Returns a summary of memory usage. The size flags are ignored and all memory sizes are given in megabytes.\n \n - swapFree : swf (bool) [create]\n Returns size of free swap\n \n - swapLogical : swl (bool) [create]\n Returns size of logical swap\n \n - swapMax : swm (bool) [create]\n Returns maximum swap size\n \n - swapPhysical : swp (bool) [create]\n Returns size of physical swap\n \n - swapReserved : swr (bool) []\n \n - swapVirtual : swv (bool) [create]\n Returns size of virtual swap\n \n - swaps : sw (bool) [create]\n Returns number of swaps Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.memory`\n "
pass<|docstring|>Used to query essential statistics on memory availability and usage. By default memory sizes are returned in bytes.
Since Maya's command engine only supports 32-bit signed integers, any returned value which cannot fit into 31 bits will
be truncated to 2,147,483,647 and a warning message displayed. To avoid having memory sizes truncated use one of the
memory size flags to return the value in larger units (e.g. megabytes) or use the asFloat flag to return the value as a
float.
Flags:
- asFloat : af (bool) [create]
Causes numeric values to be returned as floats rather than ints. This can be useful if you wish to retain some of the
significant digits lost when using the unit size flags.
- debug : dbg (bool) []
- freeMemory : fr (bool) [create]
Returns size of free memory
- gigaByte : gb (bool) [create]
Return memory sizes in gigabytes (1024\*1024\*1024 bytes)
- heapMemory : he (bool) [create]
Returns size of memory heap
- kiloByte : kb (bool) [create]
Return memory sizes in kilobytes (1024 bytes)
- megaByte : mb (bool) [create]
Return memory sizes in megabytes (1024\*1024 bytes)
- pageFaults : pf (bool) [create]
Returns number of page faults
- pageReclaims : pr (bool) [create]
Returns number of page reclaims
- physicalMemory : phy (bool) [create]
Returns size of physical memory
- summary : sum (bool) [create]
Returns a summary of memory usage. The size flags are ignored and all memory sizes are given in megabytes.
- swapFree : swf (bool) [create]
Returns size of free swap
- swapLogical : swl (bool) [create]
Returns size of logical swap
- swapMax : swm (bool) [create]
Returns maximum swap size
- swapPhysical : swp (bool) [create]
Returns size of physical swap
- swapReserved : swr (bool) []
- swapVirtual : swv (bool) [create]
Returns size of virtual swap
- swaps : sw (bool) [create]
Returns number of swaps Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.memory`<|endoftext|>
|
c69f05c7803afb6c0039bd4890c7456b39e49cb0daf9d6f0554828318558c746
|
def renameFile(newname, *args, **kwargs):
'\n Rename the scene. Used mostly during save to set the saveAs name. Returns the new name of the scene. \n \n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Rename the scene. Used mostly during save to set the saveAs name. Returns the new name of the scene.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
renameFile
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def renameFile(newname, *args, **kwargs):
'\n Rename the scene. Used mostly during save to set the saveAs name. Returns the new name of the scene. \n \n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def renameFile(newname, *args, **kwargs):
'\n Rename the scene. Used mostly during save to set the saveAs name. Returns the new name of the scene. \n \n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Rename the scene. Used mostly during save to set the saveAs name. Returns the new name of the scene.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
dae4cfcd777a22aaf0df00c5d07e3971bce889d316915a13bc32d9eb09214d6a
|
def internalVar(*args, **kwargs):
'\n This command returns the values of internal variables. No modification of these variables is supported.\n \n Flags:\n - userAppDir : uad (bool) [create]\n Return the user application directory.\n \n - userBitmapsDir : ubd (bool) [create]\n Return the user bitmaps prefs directory.\n \n - userHotkeyDir : uhk (bool) [create]\n Return the user hotkey directory.\n \n - userMarkingMenuDir : umm (bool) [create]\n Return the user marking menu directory.\n \n - userPrefDir : upd (bool) [create]\n Return the user preference directory.\n \n - userPresetsDir : ups (bool) [create]\n Return the user presets directory.\n \n - userScriptDir : usd (bool) [create]\n Return the user script directory.\n \n - userShelfDir : ush (bool) [create]\n Return the user shelves directory.\n \n - userTmpDir : utd (bool) [create]\n Return a temp directory. Will check for TMPDIR environment variable, otherwise will return the current directory.\n \n - userWorkspaceDir : uwd (bool) [create]\n Return the user workspace directory (also known as the projects directory). Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.internalVar`\n '
pass
|
This command returns the values of internal variables. No modification of these variables is supported.
Flags:
- userAppDir : uad (bool) [create]
Return the user application directory.
- userBitmapsDir : ubd (bool) [create]
Return the user bitmaps prefs directory.
- userHotkeyDir : uhk (bool) [create]
Return the user hotkey directory.
- userMarkingMenuDir : umm (bool) [create]
Return the user marking menu directory.
- userPrefDir : upd (bool) [create]
Return the user preference directory.
- userPresetsDir : ups (bool) [create]
Return the user presets directory.
- userScriptDir : usd (bool) [create]
Return the user script directory.
- userShelfDir : ush (bool) [create]
Return the user shelves directory.
- userTmpDir : utd (bool) [create]
Return a temp directory. Will check for TMPDIR environment variable, otherwise will return the current directory.
- userWorkspaceDir : uwd (bool) [create]
Return the user workspace directory (also known as the projects directory). Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.internalVar`
|
mayaSDK/pymel/core/system.py
|
internalVar
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def internalVar(*args, **kwargs):
'\n This command returns the values of internal variables. No modification of these variables is supported.\n \n Flags:\n - userAppDir : uad (bool) [create]\n Return the user application directory.\n \n - userBitmapsDir : ubd (bool) [create]\n Return the user bitmaps prefs directory.\n \n - userHotkeyDir : uhk (bool) [create]\n Return the user hotkey directory.\n \n - userMarkingMenuDir : umm (bool) [create]\n Return the user marking menu directory.\n \n - userPrefDir : upd (bool) [create]\n Return the user preference directory.\n \n - userPresetsDir : ups (bool) [create]\n Return the user presets directory.\n \n - userScriptDir : usd (bool) [create]\n Return the user script directory.\n \n - userShelfDir : ush (bool) [create]\n Return the user shelves directory.\n \n - userTmpDir : utd (bool) [create]\n Return a temp directory. Will check for TMPDIR environment variable, otherwise will return the current directory.\n \n - userWorkspaceDir : uwd (bool) [create]\n Return the user workspace directory (also known as the projects directory). Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.internalVar`\n '
pass
|
def internalVar(*args, **kwargs):
'\n This command returns the values of internal variables. No modification of these variables is supported.\n \n Flags:\n - userAppDir : uad (bool) [create]\n Return the user application directory.\n \n - userBitmapsDir : ubd (bool) [create]\n Return the user bitmaps prefs directory.\n \n - userHotkeyDir : uhk (bool) [create]\n Return the user hotkey directory.\n \n - userMarkingMenuDir : umm (bool) [create]\n Return the user marking menu directory.\n \n - userPrefDir : upd (bool) [create]\n Return the user preference directory.\n \n - userPresetsDir : ups (bool) [create]\n Return the user presets directory.\n \n - userScriptDir : usd (bool) [create]\n Return the user script directory.\n \n - userShelfDir : ush (bool) [create]\n Return the user shelves directory.\n \n - userTmpDir : utd (bool) [create]\n Return a temp directory. Will check for TMPDIR environment variable, otherwise will return the current directory.\n \n - userWorkspaceDir : uwd (bool) [create]\n Return the user workspace directory (also known as the projects directory). Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.internalVar`\n '
pass<|docstring|>This command returns the values of internal variables. No modification of these variables is supported.
Flags:
- userAppDir : uad (bool) [create]
Return the user application directory.
- userBitmapsDir : ubd (bool) [create]
Return the user bitmaps prefs directory.
- userHotkeyDir : uhk (bool) [create]
Return the user hotkey directory.
- userMarkingMenuDir : umm (bool) [create]
Return the user marking menu directory.
- userPrefDir : upd (bool) [create]
Return the user preference directory.
- userPresetsDir : ups (bool) [create]
Return the user presets directory.
- userScriptDir : usd (bool) [create]
Return the user script directory.
- userShelfDir : ush (bool) [create]
Return the user shelves directory.
- userTmpDir : utd (bool) [create]
Return a temp directory. Will check for TMPDIR environment variable, otherwise will return the current directory.
- userWorkspaceDir : uwd (bool) [create]
Return the user workspace directory (also known as the projects directory). Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.internalVar`<|endoftext|>
|
9642227393b0e4e710dd2bcda5699c3fe047ddc894734312af8b653534f39acc
|
def cmdFileOutput(*args, **kwargs):
'\n This command will open a text file to receive all of the commands and results that normally get printed to the Script\n Editor window or console. The file will stay open until an explicit -close with the correct file descriptor or a\n -closeAll, so care should be taken not to leave a file open. To enable logging to commence as soon as Maya starts up,\n the environment variable MAYA_CMD_FILE_OUTPUT may be specified prior to launching Maya. Setting MAYA_CMD_FILE_OUTPUT to\n a filename will create and output to that given file. To access the descriptor after Maya has started, use the -query\n and -open flags together.\n \n Flags:\n - close : c (int) [create]\n Closes the file corresponding to the given descriptor. If -3 is returned, the file did not exist. -1 is returned on\n error, 0 is returned on successful close.\n \n - closeAll : ca (bool) [create]\n Closes all open files.\n \n - open : o (unicode) [create,query]\n Opens the given file for writing (will overwrite if it exists and is writable). If successful, a value is returned to\n enable status queries and file close. -1 is returned if the file cannot be opened for writing. The -open flag can also\n be specified in -query mode. In query mode, if the named file is currently opened, the descriptor for the specified file\n is returned, otherwise -1 is returned. This is an easy way to check if a given file is currently open.\n \n - status : s (int) [create,query]\n Queries the status of the given descriptor. -3 is returned if no such file exists, -2 indicates the file is not open, -1\n indicates an error condition, 0 indicates file is ready for writing. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cmdFileOutput`\n '
pass
|
This command will open a text file to receive all of the commands and results that normally get printed to the Script
Editor window or console. The file will stay open until an explicit -close with the correct file descriptor or a
-closeAll, so care should be taken not to leave a file open. To enable logging to commence as soon as Maya starts up,
the environment variable MAYA_CMD_FILE_OUTPUT may be specified prior to launching Maya. Setting MAYA_CMD_FILE_OUTPUT to
a filename will create and output to that given file. To access the descriptor after Maya has started, use the -query
and -open flags together.
Flags:
- close : c (int) [create]
Closes the file corresponding to the given descriptor. If -3 is returned, the file did not exist. -1 is returned on
error, 0 is returned on successful close.
- closeAll : ca (bool) [create]
Closes all open files.
- open : o (unicode) [create,query]
Opens the given file for writing (will overwrite if it exists and is writable). If successful, a value is returned to
enable status queries and file close. -1 is returned if the file cannot be opened for writing. The -open flag can also
be specified in -query mode. In query mode, if the named file is currently opened, the descriptor for the specified file
is returned, otherwise -1 is returned. This is an easy way to check if a given file is currently open.
- status : s (int) [create,query]
Queries the status of the given descriptor. -3 is returned if no such file exists, -2 indicates the file is not open, -1
indicates an error condition, 0 indicates file is ready for writing. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.cmdFileOutput`
|
mayaSDK/pymel/core/system.py
|
cmdFileOutput
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def cmdFileOutput(*args, **kwargs):
'\n This command will open a text file to receive all of the commands and results that normally get printed to the Script\n Editor window or console. The file will stay open until an explicit -close with the correct file descriptor or a\n -closeAll, so care should be taken not to leave a file open. To enable logging to commence as soon as Maya starts up,\n the environment variable MAYA_CMD_FILE_OUTPUT may be specified prior to launching Maya. Setting MAYA_CMD_FILE_OUTPUT to\n a filename will create and output to that given file. To access the descriptor after Maya has started, use the -query\n and -open flags together.\n \n Flags:\n - close : c (int) [create]\n Closes the file corresponding to the given descriptor. If -3 is returned, the file did not exist. -1 is returned on\n error, 0 is returned on successful close.\n \n - closeAll : ca (bool) [create]\n Closes all open files.\n \n - open : o (unicode) [create,query]\n Opens the given file for writing (will overwrite if it exists and is writable). If successful, a value is returned to\n enable status queries and file close. -1 is returned if the file cannot be opened for writing. The -open flag can also\n be specified in -query mode. In query mode, if the named file is currently opened, the descriptor for the specified file\n is returned, otherwise -1 is returned. This is an easy way to check if a given file is currently open.\n \n - status : s (int) [create,query]\n Queries the status of the given descriptor. -3 is returned if no such file exists, -2 indicates the file is not open, -1\n indicates an error condition, 0 indicates file is ready for writing. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cmdFileOutput`\n '
pass
|
def cmdFileOutput(*args, **kwargs):
'\n This command will open a text file to receive all of the commands and results that normally get printed to the Script\n Editor window or console. The file will stay open until an explicit -close with the correct file descriptor or a\n -closeAll, so care should be taken not to leave a file open. To enable logging to commence as soon as Maya starts up,\n the environment variable MAYA_CMD_FILE_OUTPUT may be specified prior to launching Maya. Setting MAYA_CMD_FILE_OUTPUT to\n a filename will create and output to that given file. To access the descriptor after Maya has started, use the -query\n and -open flags together.\n \n Flags:\n - close : c (int) [create]\n Closes the file corresponding to the given descriptor. If -3 is returned, the file did not exist. -1 is returned on\n error, 0 is returned on successful close.\n \n - closeAll : ca (bool) [create]\n Closes all open files.\n \n - open : o (unicode) [create,query]\n Opens the given file for writing (will overwrite if it exists and is writable). If successful, a value is returned to\n enable status queries and file close. -1 is returned if the file cannot be opened for writing. The -open flag can also\n be specified in -query mode. In query mode, if the named file is currently opened, the descriptor for the specified file\n is returned, otherwise -1 is returned. This is an easy way to check if a given file is currently open.\n \n - status : s (int) [create,query]\n Queries the status of the given descriptor. -3 is returned if no such file exists, -2 indicates the file is not open, -1\n indicates an error condition, 0 indicates file is ready for writing. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cmdFileOutput`\n '
pass<|docstring|>This command will open a text file to receive all of the commands and results that normally get printed to the Script
Editor window or console. The file will stay open until an explicit -close with the correct file descriptor or a
-closeAll, so care should be taken not to leave a file open. To enable logging to commence as soon as Maya starts up,
the environment variable MAYA_CMD_FILE_OUTPUT may be specified prior to launching Maya. Setting MAYA_CMD_FILE_OUTPUT to
a filename will create and output to that given file. To access the descriptor after Maya has started, use the -query
and -open flags together.
Flags:
- close : c (int) [create]
Closes the file corresponding to the given descriptor. If -3 is returned, the file did not exist. -1 is returned on
error, 0 is returned on successful close.
- closeAll : ca (bool) [create]
Closes all open files.
- open : o (unicode) [create,query]
Opens the given file for writing (will overwrite if it exists and is writable). If successful, a value is returned to
enable status queries and file close. -1 is returned if the file cannot be opened for writing. The -open flag can also
be specified in -query mode. In query mode, if the named file is currently opened, the descriptor for the specified file
is returned, otherwise -1 is returned. This is an easy way to check if a given file is currently open.
- status : s (int) [create,query]
Queries the status of the given descriptor. -3 is returned if no such file exists, -2 indicates the file is not open, -1
indicates an error condition, 0 indicates file is ready for writing. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.cmdFileOutput`<|endoftext|>
|
b038c39c7de0dbcb63787c8a3446bec6cc26981a770d818eecfb0c9ce3fbd208
|
def cacheFileMerge(*args, **kwargs):
'\n If selected/specified caches can be successfully merged, will return the start/end frames of the new cache followed by\n the start/end frames of any gaps in the merged cache for which no data should be written to file. In query mode, will\n return the names of geometry associated with the specified cache file nodes.\n \n Flags:\n - endTime : et (time) [create]\n Specifies the end frame of the merge range. If not specified, will figure out range from times of caches being merged.\n \n - geometry : g (bool) [query]\n Query-only flag used to find the geometry nodes associated with the specified cache files.\n \n - startTime : st (time) [create]\n Specifies the start frame of the merge range. If not specified, will figure out range from the times of the caches being\n merged. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cacheFileMerge`\n '
pass
|
If selected/specified caches can be successfully merged, will return the start/end frames of the new cache followed by
the start/end frames of any gaps in the merged cache for which no data should be written to file. In query mode, will
return the names of geometry associated with the specified cache file nodes.
Flags:
- endTime : et (time) [create]
Specifies the end frame of the merge range. If not specified, will figure out range from times of caches being merged.
- geometry : g (bool) [query]
Query-only flag used to find the geometry nodes associated with the specified cache files.
- startTime : st (time) [create]
Specifies the start frame of the merge range. If not specified, will figure out range from the times of the caches being
merged. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.cacheFileMerge`
|
mayaSDK/pymel/core/system.py
|
cacheFileMerge
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def cacheFileMerge(*args, **kwargs):
'\n If selected/specified caches can be successfully merged, will return the start/end frames of the new cache followed by\n the start/end frames of any gaps in the merged cache for which no data should be written to file. In query mode, will\n return the names of geometry associated with the specified cache file nodes.\n \n Flags:\n - endTime : et (time) [create]\n Specifies the end frame of the merge range. If not specified, will figure out range from times of caches being merged.\n \n - geometry : g (bool) [query]\n Query-only flag used to find the geometry nodes associated with the specified cache files.\n \n - startTime : st (time) [create]\n Specifies the start frame of the merge range. If not specified, will figure out range from the times of the caches being\n merged. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cacheFileMerge`\n '
pass
|
def cacheFileMerge(*args, **kwargs):
'\n If selected/specified caches can be successfully merged, will return the start/end frames of the new cache followed by\n the start/end frames of any gaps in the merged cache for which no data should be written to file. In query mode, will\n return the names of geometry associated with the specified cache file nodes.\n \n Flags:\n - endTime : et (time) [create]\n Specifies the end frame of the merge range. If not specified, will figure out range from times of caches being merged.\n \n - geometry : g (bool) [query]\n Query-only flag used to find the geometry nodes associated with the specified cache files.\n \n - startTime : st (time) [create]\n Specifies the start frame of the merge range. If not specified, will figure out range from the times of the caches being\n merged. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.cacheFileMerge`\n '
pass<|docstring|>If selected/specified caches can be successfully merged, will return the start/end frames of the new cache followed by
the start/end frames of any gaps in the merged cache for which no data should be written to file. In query mode, will
return the names of geometry associated with the specified cache file nodes.
Flags:
- endTime : et (time) [create]
Specifies the end frame of the merge range. If not specified, will figure out range from times of caches being merged.
- geometry : g (bool) [query]
Query-only flag used to find the geometry nodes associated with the specified cache files.
- startTime : st (time) [create]
Specifies the start frame of the merge range. If not specified, will figure out range from the times of the caches being
merged. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.cacheFileMerge`<|endoftext|>
|
f1aa39e17a47fd95db06e17b8ed77f173004c067534a6cb0aefc413c15abbfa6
|
def aaf2fcp(*args, **kwargs):
'\n This command is used to convert an aff file to a Final Cut Pro (fcp) xml file The conversion process can take several\n seconds to complete and the command is meant to be run asynchronously\n \n Flags:\n - deleteFile : df (bool) [create]\n Delete temporary file. Can only be used with the terminate option\n \n - dstPath : dst (unicode) [create]\n Specifiy a destination path\n \n - getFileName : gfn (int) [create]\n Query output file name\n \n - progress : pr (int) [create]\n Request progress report\n \n - srcFile : src (unicode) [create]\n Specifiy a source file\n \n - terminate : t (int) [create]\n Complete the task\n \n - waitCompletion : wc (int) [create]\n Wait for the conversion process to complete Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.aaf2fcp`\n '
pass
|
This command is used to convert an aff file to a Final Cut Pro (fcp) xml file The conversion process can take several
seconds to complete and the command is meant to be run asynchronously
Flags:
- deleteFile : df (bool) [create]
Delete temporary file. Can only be used with the terminate option
- dstPath : dst (unicode) [create]
Specifiy a destination path
- getFileName : gfn (int) [create]
Query output file name
- progress : pr (int) [create]
Request progress report
- srcFile : src (unicode) [create]
Specifiy a source file
- terminate : t (int) [create]
Complete the task
- waitCompletion : wc (int) [create]
Wait for the conversion process to complete Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.aaf2fcp`
|
mayaSDK/pymel/core/system.py
|
aaf2fcp
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def aaf2fcp(*args, **kwargs):
'\n This command is used to convert an aff file to a Final Cut Pro (fcp) xml file The conversion process can take several\n seconds to complete and the command is meant to be run asynchronously\n \n Flags:\n - deleteFile : df (bool) [create]\n Delete temporary file. Can only be used with the terminate option\n \n - dstPath : dst (unicode) [create]\n Specifiy a destination path\n \n - getFileName : gfn (int) [create]\n Query output file name\n \n - progress : pr (int) [create]\n Request progress report\n \n - srcFile : src (unicode) [create]\n Specifiy a source file\n \n - terminate : t (int) [create]\n Complete the task\n \n - waitCompletion : wc (int) [create]\n Wait for the conversion process to complete Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.aaf2fcp`\n '
pass
|
def aaf2fcp(*args, **kwargs):
'\n This command is used to convert an aff file to a Final Cut Pro (fcp) xml file The conversion process can take several\n seconds to complete and the command is meant to be run asynchronously\n \n Flags:\n - deleteFile : df (bool) [create]\n Delete temporary file. Can only be used with the terminate option\n \n - dstPath : dst (unicode) [create]\n Specifiy a destination path\n \n - getFileName : gfn (int) [create]\n Query output file name\n \n - progress : pr (int) [create]\n Request progress report\n \n - srcFile : src (unicode) [create]\n Specifiy a source file\n \n - terminate : t (int) [create]\n Complete the task\n \n - waitCompletion : wc (int) [create]\n Wait for the conversion process to complete Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.aaf2fcp`\n '
pass<|docstring|>This command is used to convert an aff file to a Final Cut Pro (fcp) xml file The conversion process can take several
seconds to complete and the command is meant to be run asynchronously
Flags:
- deleteFile : df (bool) [create]
Delete temporary file. Can only be used with the terminate option
- dstPath : dst (unicode) [create]
Specifiy a destination path
- getFileName : gfn (int) [create]
Query output file name
- progress : pr (int) [create]
Request progress report
- srcFile : src (unicode) [create]
Specifiy a source file
- terminate : t (int) [create]
Complete the task
- waitCompletion : wc (int) [create]
Wait for the conversion process to complete Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.aaf2fcp`<|endoftext|>
|
70378f7a1fb44a18503044a183d1f9c3a9a955779e00a1307fb2b8950d80ed6a
|
def redo(*args, **kwargs):
'\n Takes the most recently undone command from the undo list and redoes it.\n \n \n Derived from mel command `maya.cmds.redo`\n '
pass
|
Takes the most recently undone command from the undo list and redoes it.
Derived from mel command `maya.cmds.redo`
|
mayaSDK/pymel/core/system.py
|
redo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def redo(*args, **kwargs):
'\n Takes the most recently undone command from the undo list and redoes it.\n \n \n Derived from mel command `maya.cmds.redo`\n '
pass
|
def redo(*args, **kwargs):
'\n Takes the most recently undone command from the undo list and redoes it.\n \n \n Derived from mel command `maya.cmds.redo`\n '
pass<|docstring|>Takes the most recently undone command from the undo list and redoes it.
Derived from mel command `maya.cmds.redo`<|endoftext|>
|
14bbbc026d5ceebd17c62fa99f998f38e1279f1d6814fc396bc2643401ba6f46
|
def dgfilter(*args, **kwargs):
"\n The dgfiltercommand is used to define Dependency Graph filters that select DG objects based on certain criteria. The\n command itself can be used to filter objects or it can be attached to a dbtraceobject to selectively filter what output\n is traced. If objects are specified then apply the filter to those objects and return a boolean indicating whether they\n passed or not, otherwise return then name of the filter. An invalid filter will pass all objects. For multiple objects\n the return value is the logical ANDof all object's return values.\n \n Dynamic library stub function\n \n Flags:\n - attribute : atr (unicode) [create]\n Select objects whose attribute names match the pattern.\n \n - list : l (bool) [create]\n List the available filters. If used in conjunction with the -nameflag it will show a description of what the filter is.\n \n - logicalAnd : logicalAnd (unicode, unicode) [create]\n Logical AND of two filters.\n \n - logicalNot : logicalNot (unicode) [create]\n Logical inverse of filter.\n \n - logicalOr : logicalOr (unicode, unicode) [create]\n Logical OR of two filters.\n \n - name : n (unicode) [create]\n Use filter named FILTER (or create new filter with that name). If no objects are specified then the name given to the\n filter will be returned.\n \n - node : nd (unicode) [create]\n Select objects whose node names match the pattern.\n \n - nodeType : nt (unicode) [create]\n Select objects whose node type names match the pattern.\n \n - plug : p (unicode) [create]\n Select objects whose plug names match the pattern. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgfilter`\n "
pass
|
The dgfiltercommand is used to define Dependency Graph filters that select DG objects based on certain criteria. The
command itself can be used to filter objects or it can be attached to a dbtraceobject to selectively filter what output
is traced. If objects are specified then apply the filter to those objects and return a boolean indicating whether they
passed or not, otherwise return then name of the filter. An invalid filter will pass all objects. For multiple objects
the return value is the logical ANDof all object's return values.
Dynamic library stub function
Flags:
- attribute : atr (unicode) [create]
Select objects whose attribute names match the pattern.
- list : l (bool) [create]
List the available filters. If used in conjunction with the -nameflag it will show a description of what the filter is.
- logicalAnd : logicalAnd (unicode, unicode) [create]
Logical AND of two filters.
- logicalNot : logicalNot (unicode) [create]
Logical inverse of filter.
- logicalOr : logicalOr (unicode, unicode) [create]
Logical OR of two filters.
- name : n (unicode) [create]
Use filter named FILTER (or create new filter with that name). If no objects are specified then the name given to the
filter will be returned.
- node : nd (unicode) [create]
Select objects whose node names match the pattern.
- nodeType : nt (unicode) [create]
Select objects whose node type names match the pattern.
- plug : p (unicode) [create]
Select objects whose plug names match the pattern. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.dgfilter`
|
mayaSDK/pymel/core/system.py
|
dgfilter
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def dgfilter(*args, **kwargs):
"\n The dgfiltercommand is used to define Dependency Graph filters that select DG objects based on certain criteria. The\n command itself can be used to filter objects or it can be attached to a dbtraceobject to selectively filter what output\n is traced. If objects are specified then apply the filter to those objects and return a boolean indicating whether they\n passed or not, otherwise return then name of the filter. An invalid filter will pass all objects. For multiple objects\n the return value is the logical ANDof all object's return values.\n \n Dynamic library stub function\n \n Flags:\n - attribute : atr (unicode) [create]\n Select objects whose attribute names match the pattern.\n \n - list : l (bool) [create]\n List the available filters. If used in conjunction with the -nameflag it will show a description of what the filter is.\n \n - logicalAnd : logicalAnd (unicode, unicode) [create]\n Logical AND of two filters.\n \n - logicalNot : logicalNot (unicode) [create]\n Logical inverse of filter.\n \n - logicalOr : logicalOr (unicode, unicode) [create]\n Logical OR of two filters.\n \n - name : n (unicode) [create]\n Use filter named FILTER (or create new filter with that name). If no objects are specified then the name given to the\n filter will be returned.\n \n - node : nd (unicode) [create]\n Select objects whose node names match the pattern.\n \n - nodeType : nt (unicode) [create]\n Select objects whose node type names match the pattern.\n \n - plug : p (unicode) [create]\n Select objects whose plug names match the pattern. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgfilter`\n "
pass
|
def dgfilter(*args, **kwargs):
"\n The dgfiltercommand is used to define Dependency Graph filters that select DG objects based on certain criteria. The\n command itself can be used to filter objects or it can be attached to a dbtraceobject to selectively filter what output\n is traced. If objects are specified then apply the filter to those objects and return a boolean indicating whether they\n passed or not, otherwise return then name of the filter. An invalid filter will pass all objects. For multiple objects\n the return value is the logical ANDof all object's return values.\n \n Dynamic library stub function\n \n Flags:\n - attribute : atr (unicode) [create]\n Select objects whose attribute names match the pattern.\n \n - list : l (bool) [create]\n List the available filters. If used in conjunction with the -nameflag it will show a description of what the filter is.\n \n - logicalAnd : logicalAnd (unicode, unicode) [create]\n Logical AND of two filters.\n \n - logicalNot : logicalNot (unicode) [create]\n Logical inverse of filter.\n \n - logicalOr : logicalOr (unicode, unicode) [create]\n Logical OR of two filters.\n \n - name : n (unicode) [create]\n Use filter named FILTER (or create new filter with that name). If no objects are specified then the name given to the\n filter will be returned.\n \n - node : nd (unicode) [create]\n Select objects whose node names match the pattern.\n \n - nodeType : nt (unicode) [create]\n Select objects whose node type names match the pattern.\n \n - plug : p (unicode) [create]\n Select objects whose plug names match the pattern. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.dgfilter`\n "
pass<|docstring|>The dgfiltercommand is used to define Dependency Graph filters that select DG objects based on certain criteria. The
command itself can be used to filter objects or it can be attached to a dbtraceobject to selectively filter what output
is traced. If objects are specified then apply the filter to those objects and return a boolean indicating whether they
passed or not, otherwise return then name of the filter. An invalid filter will pass all objects. For multiple objects
the return value is the logical ANDof all object's return values.
Dynamic library stub function
Flags:
- attribute : atr (unicode) [create]
Select objects whose attribute names match the pattern.
- list : l (bool) [create]
List the available filters. If used in conjunction with the -nameflag it will show a description of what the filter is.
- logicalAnd : logicalAnd (unicode, unicode) [create]
Logical AND of two filters.
- logicalNot : logicalNot (unicode) [create]
Logical inverse of filter.
- logicalOr : logicalOr (unicode, unicode) [create]
Logical OR of two filters.
- name : n (unicode) [create]
Use filter named FILTER (or create new filter with that name). If no objects are specified then the name given to the
filter will be returned.
- node : nd (unicode) [create]
Select objects whose node names match the pattern.
- nodeType : nt (unicode) [create]
Select objects whose node type names match the pattern.
- plug : p (unicode) [create]
Select objects whose plug names match the pattern. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.dgfilter`<|endoftext|>
|
08ef8490d0929e782d25dbbb496325666694afbbb8c5ef3fcb024060fdca7ede
|
def date(*args, **kwargs):
'\n Returns information about current time and date. Use the predefined formats, or the -formatflag to specify the output\n format.\n \n Flags:\n - date : d (bool) [create]\n Returns the current date. Format is YYYY/MM/DD\n \n - format : f (unicode) [create]\n Specifies a string defining how the date and time should be represented. All occurences of the keywords below will be\n replaced with the corresponding values: KeywordBecomesYYYYCurrent year, using 4 digitsYYLast two digits of the current\n yearMMCurrent month, with leading 0 if necessaryDDCurrent day, with leading 0 if necessaryhhCurrent hour, with leading 0\n if necessarymmCurrent minute, with leading 0 if necessaryssCurrent second, with leading 0 if necessary\n \n - shortDate : sd (bool) [create]\n Returns the current date. Format is MM/DD\n \n - shortTime : st (bool) [create]\n Returns the current time. Format is hh:mm\n \n - time : t (bool) [create]\n Returns the current time. Format is hh:mm:ss Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.date`\n '
pass
|
Returns information about current time and date. Use the predefined formats, or the -formatflag to specify the output
format.
Flags:
- date : d (bool) [create]
Returns the current date. Format is YYYY/MM/DD
- format : f (unicode) [create]
Specifies a string defining how the date and time should be represented. All occurences of the keywords below will be
replaced with the corresponding values: KeywordBecomesYYYYCurrent year, using 4 digitsYYLast two digits of the current
yearMMCurrent month, with leading 0 if necessaryDDCurrent day, with leading 0 if necessaryhhCurrent hour, with leading 0
if necessarymmCurrent minute, with leading 0 if necessaryssCurrent second, with leading 0 if necessary
- shortDate : sd (bool) [create]
Returns the current date. Format is MM/DD
- shortTime : st (bool) [create]
Returns the current time. Format is hh:mm
- time : t (bool) [create]
Returns the current time. Format is hh:mm:ss Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.date`
|
mayaSDK/pymel/core/system.py
|
date
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def date(*args, **kwargs):
'\n Returns information about current time and date. Use the predefined formats, or the -formatflag to specify the output\n format.\n \n Flags:\n - date : d (bool) [create]\n Returns the current date. Format is YYYY/MM/DD\n \n - format : f (unicode) [create]\n Specifies a string defining how the date and time should be represented. All occurences of the keywords below will be\n replaced with the corresponding values: KeywordBecomesYYYYCurrent year, using 4 digitsYYLast two digits of the current\n yearMMCurrent month, with leading 0 if necessaryDDCurrent day, with leading 0 if necessaryhhCurrent hour, with leading 0\n if necessarymmCurrent minute, with leading 0 if necessaryssCurrent second, with leading 0 if necessary\n \n - shortDate : sd (bool) [create]\n Returns the current date. Format is MM/DD\n \n - shortTime : st (bool) [create]\n Returns the current time. Format is hh:mm\n \n - time : t (bool) [create]\n Returns the current time. Format is hh:mm:ss Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.date`\n '
pass
|
def date(*args, **kwargs):
'\n Returns information about current time and date. Use the predefined formats, or the -formatflag to specify the output\n format.\n \n Flags:\n - date : d (bool) [create]\n Returns the current date. Format is YYYY/MM/DD\n \n - format : f (unicode) [create]\n Specifies a string defining how the date and time should be represented. All occurences of the keywords below will be\n replaced with the corresponding values: KeywordBecomesYYYYCurrent year, using 4 digitsYYLast two digits of the current\n yearMMCurrent month, with leading 0 if necessaryDDCurrent day, with leading 0 if necessaryhhCurrent hour, with leading 0\n if necessarymmCurrent minute, with leading 0 if necessaryssCurrent second, with leading 0 if necessary\n \n - shortDate : sd (bool) [create]\n Returns the current date. Format is MM/DD\n \n - shortTime : st (bool) [create]\n Returns the current time. Format is hh:mm\n \n - time : t (bool) [create]\n Returns the current time. Format is hh:mm:ss Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.date`\n '
pass<|docstring|>Returns information about current time and date. Use the predefined formats, or the -formatflag to specify the output
format.
Flags:
- date : d (bool) [create]
Returns the current date. Format is YYYY/MM/DD
- format : f (unicode) [create]
Specifies a string defining how the date and time should be represented. All occurences of the keywords below will be
replaced with the corresponding values: KeywordBecomesYYYYCurrent year, using 4 digitsYYLast two digits of the current
yearMMCurrent month, with leading 0 if necessaryDDCurrent day, with leading 0 if necessaryhhCurrent hour, with leading 0
if necessarymmCurrent minute, with leading 0 if necessaryssCurrent second, with leading 0 if necessary
- shortDate : sd (bool) [create]
Returns the current date. Format is MM/DD
- shortTime : st (bool) [create]
Returns the current time. Format is hh:mm
- time : t (bool) [create]
Returns the current time. Format is hh:mm:ss Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.date`<|endoftext|>
|
92d2841b673dcd881519acbb588a2747d13366d5c5e53d605adafe7dad179cd4
|
def namespace(*args, **kwargs):
"\n This command allows a namespace to be created, set or removed. A namespace is a simple grouping of objects under a given\n name. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the same name as an\n existing object (from importing a file, for example). Using namespaces, you can have two objects with the same name, as\n long as they are contained in differenct namespaces. Namespaces are reminiscent of hierarchical structures like file\n systems where namespaces are analogous to directories and objects are analogous to files. The colon (':') character is\n the separator used to separate the names of namespaces and nodes instead of the slash ('/') or backslash ('')\n character. Namespaces can contain other namespaces as well as objects. Like objects, the names of namespaces must be\n unique within another namespace. Objects and namespaces can be in only one namespace. Namespace names and object names\n don't clash so a namespace and an object contained in another namespace can have the same name. There is an unnamed root\n namespace specified with a leading colon (':'). Any object not in a named namespace is in the root namespace. Normally,\n the leading colon is omitted from the name of an object as it's presence is implied. The presence of a leading colon is\n important when moving objects between namespaces using the 'rename' command. For the 'rename' command, the new name is\n relative to the current namespace unless the new name is fully qualified with a leading colon. Namespaces are created\n using the 'add/addNamespace' flag. By default they are created under the current namespace. Changing the current\n namespace is done with the 'set/setNamespace' flag. To reset the current namespace to the root namespace, use 'namespace\n -set :;'. Whenever an object is created, it is added by default to the current namespace. When creating a new namespace\n using a qualified name, any intervening namespaces which do not yet exist will be automatically created. For example, if\n the name of the new namespace is specified as A:Band the current namespace already has a child namespace named Athen a\n new child namespace named Bwill be created under A. But if the current namespace does not yet have a child named Athen\n it will be created automatically. This applies regardless of the number of levels in the provided name (e.g. A:B:C:D).\n The 'p/parent' flag can be used to explicitly specify the parent namespace under which the new one should be created,\n rather than just defaulting to the current namespace. If the name given for the new namespace is absolute (i.e. it\n begins with a colon, as in :A:B) then both the current namespace and the 'parent' flag will be ignored and the new\n namespace will be created under the root namespace. The relativeNamespace flag can be used to change the way node names\n are displayed in the UI and returned by the 'ls' command. Here are some specific details on how the return from the 'ls'\n command works in relativeNamespace mode: List all mesh objects in the scene:ls -type mesh;The above command lists all\n mesh objects in the root and any child namespaces. In relative name lookup mode, all names will be displayed relative to\n the current namespace. When not in relative name lookup mode (the default behaviour in Maya), results are printed\n relative to the root namespace. Using a \\*wildcard:namespace -set myNS;ls -type mesh \\*;In relative name lookup mode,\n the \\*will match to the current namespace and thus the ls command will list only those meshes defined within the current\n namespace (i.e. myNs). If relative name lookup is off (the default behaviour in Maya), names are root-relative and thus\n \\*matches the root namespace, with the net result being that only thoses meshes defined in the root namespace will be\n listed. You can force the root namespace to be listed when in relative name lookup mode by specifying :\\*as your search\n pattern (i.e. ls -type mesh :\\*which lists those meshes defined in the root namespace only). Note that you can also use\n :\\*when relative name lookup mode is off to match the root if you want a consistent way to list the root. Listing child\n namespace contents:ls -type mesh \\*:\\*;For an example to list all meshes in immediate child namespaces, use \\*:\\*. In\n relative name lookup mode \\*:\\*lists those meshes in immediate child namespaces of the current namespaces. When not in\n relative name lookup mode, \\*:\\*lists meshes in namespaces one level below the root. Recursive listing of namespace\n contents:Example: ls -type mesh -recurse on \\*The 'recurse' flag is provided on the lscommand to recursively traverse\n any child namespaces. In relative name lookup mode, the above example command will list all meshes in the current and\n any child namespaces of current. When not in relative name lookup mode, the above example command works from the root\n downwards and is thus equivalent to ls -type mesh.\n \n Flags:\n - absoluteName : an (bool) [create,query]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent\n namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not.\n \n - addNamespace : add (unicode) [create]\n Create a new namespace with the given name. Both qualified names (A:B) and unqualified names (A) are acceptable. If any\n of the higher-level namespaces in a qualified name do not yet exist, they will be created. If the supplied name contains\n invalid characters it will first be modified as per the validateName flag.\n \n - collapseAncestors : ch (unicode) [create]\n Delete all empty ancestors of the given namespace. An empty namespace is a a namespace that does not contain any objects\n or other nested namespaces\n \n - deleteNamespaceContent : dnc (bool) [create]\n Used with the 'rm/removeNamespace' flag to indicate that when removing a namespace the contents of the namespace will\n also be removed.\n \n - exists : ex (unicode) [query]\n Returns true if the specified namespace exists, false if not.\n \n - force : f (bool) [create]\n Used with 'mv/moveNamespace' to force the move operation to ignore name clashes.\n \n - isRootNamespace : ir (unicode) [query]\n Returns true if the specified namespace is root, false if not.\n \n - mergeNamespaceWithParent : mnp (bool) [create]\n Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the parent\n namespace.\n \n - mergeNamespaceWithRoot : mnr (bool) [create]\n Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the root\n namespace.\n \n - moveNamespace : mv (unicode, unicode) [create]\n Move the contents of the first namespace into the second namespace. Child namespaces will also be moved. Attempting to\n move a namespace containing referenced nodes will result in an error; use the 'file' command ('file -edit -namespace')\n to change a reference namespace. If there are objects in the source namespace with the same name as objects in the\n destination namespace, an error will be issued. Use the 'force' flag to override this error - name clashes will be\n resolved by renaming the objects to ensure uniqueness.\n \n - parent : p (unicode) [create]\n Used with the 'addNamespace' or 'rename' flags to specifiy the parent of the new namespace. The full namespace parent\n path is required. When using 'addNamespace' with an absolute name, the 'parent' will be ignored and the command will\n display a warning\n \n - recurse : r (bool) [query]\n Can be used with the 'exists' flag to recursively look for the specified namespace\n \n - relativeNames : rel (bool) [create,query]\n Turns on relative name lookup, which causes name lookups within Maya to be relative to the current namespace. By default\n this is off, meaning that name lookups are always relative to the root namespace. Be careful turning this feature on\n since commands such as setAttr will behave differently. It is wise to only turn this feature on while executing custom\n procedures that you have written to be namespace independent and turning relativeNames off when returning control from\n your custom procedures. Note that Maya will turn on relative naming during file I/O. Although it is not recommended to\n leave relativeNames turned on, if you try to toggle the value during file I/O you may notice that the value stays\n onbecause Maya has already temporarily enabled it internally. When relativeNames are enabled, the returns provided by\n the 'ls' command will be relative to the current namespace. See the main description of this command for more details.\n \n - removeNamespace : rm (unicode) [create]\n Deletes the given namespace. The namespace must be empty for it to be deleted.\n \n - rename : ren (unicode, unicode) [create]\n Rename the first namespace to second namespace name. Child namespaces will also be renamed. Both names are relative to\n the current namespace. Use the 'parent' flag to specify a parent namespace for the renamed namespace. An error is issued\n if the second namespace name already exists. If the supplied name contains invalid characters it will first be modified\n as per the validateName flag.\n \n - setNamespace : set (unicode) [create]\n Sets the current namespace.\n \n - validateName : vn (unicode) [create]\n Convert the specified name to a valid name to make it contain no illegal characters. The leading illegal characters will\n be removed and other illegal characters will be converted to '_'. Specially, the leading numeric characters and trailing\n space characters will be also removed. Full name path can be validated as well. However, if the namespace of the path\n does not exist, command will only return the base name. For example, :nonExistentNS:namewill be converted to name. If\n the entire name consists solely of illegal characters, e.g. 123which contains only leading digits, then the returned\n string will be empty. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.namespace`\n "
pass
|
This command allows a namespace to be created, set or removed. A namespace is a simple grouping of objects under a given
name. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the same name as an
existing object (from importing a file, for example). Using namespaces, you can have two objects with the same name, as
long as they are contained in differenct namespaces. Namespaces are reminiscent of hierarchical structures like file
systems where namespaces are analogous to directories and objects are analogous to files. The colon (':') character is
the separator used to separate the names of namespaces and nodes instead of the slash ('/') or backslash ('')
character. Namespaces can contain other namespaces as well as objects. Like objects, the names of namespaces must be
unique within another namespace. Objects and namespaces can be in only one namespace. Namespace names and object names
don't clash so a namespace and an object contained in another namespace can have the same name. There is an unnamed root
namespace specified with a leading colon (':'). Any object not in a named namespace is in the root namespace. Normally,
the leading colon is omitted from the name of an object as it's presence is implied. The presence of a leading colon is
important when moving objects between namespaces using the 'rename' command. For the 'rename' command, the new name is
relative to the current namespace unless the new name is fully qualified with a leading colon. Namespaces are created
using the 'add/addNamespace' flag. By default they are created under the current namespace. Changing the current
namespace is done with the 'set/setNamespace' flag. To reset the current namespace to the root namespace, use 'namespace
-set :;'. Whenever an object is created, it is added by default to the current namespace. When creating a new namespace
using a qualified name, any intervening namespaces which do not yet exist will be automatically created. For example, if
the name of the new namespace is specified as A:Band the current namespace already has a child namespace named Athen a
new child namespace named Bwill be created under A. But if the current namespace does not yet have a child named Athen
it will be created automatically. This applies regardless of the number of levels in the provided name (e.g. A:B:C:D).
The 'p/parent' flag can be used to explicitly specify the parent namespace under which the new one should be created,
rather than just defaulting to the current namespace. If the name given for the new namespace is absolute (i.e. it
begins with a colon, as in :A:B) then both the current namespace and the 'parent' flag will be ignored and the new
namespace will be created under the root namespace. The relativeNamespace flag can be used to change the way node names
are displayed in the UI and returned by the 'ls' command. Here are some specific details on how the return from the 'ls'
command works in relativeNamespace mode: List all mesh objects in the scene:ls -type mesh;The above command lists all
mesh objects in the root and any child namespaces. In relative name lookup mode, all names will be displayed relative to
the current namespace. When not in relative name lookup mode (the default behaviour in Maya), results are printed
relative to the root namespace. Using a \*wildcard:namespace -set myNS;ls -type mesh \*;In relative name lookup mode,
the \*will match to the current namespace and thus the ls command will list only those meshes defined within the current
namespace (i.e. myNs). If relative name lookup is off (the default behaviour in Maya), names are root-relative and thus
\*matches the root namespace, with the net result being that only thoses meshes defined in the root namespace will be
listed. You can force the root namespace to be listed when in relative name lookup mode by specifying :\*as your search
pattern (i.e. ls -type mesh :\*which lists those meshes defined in the root namespace only). Note that you can also use
:\*when relative name lookup mode is off to match the root if you want a consistent way to list the root. Listing child
namespace contents:ls -type mesh \*:\*;For an example to list all meshes in immediate child namespaces, use \*:\*. In
relative name lookup mode \*:\*lists those meshes in immediate child namespaces of the current namespaces. When not in
relative name lookup mode, \*:\*lists meshes in namespaces one level below the root. Recursive listing of namespace
contents:Example: ls -type mesh -recurse on \*The 'recurse' flag is provided on the lscommand to recursively traverse
any child namespaces. In relative name lookup mode, the above example command will list all meshes in the current and
any child namespaces of current. When not in relative name lookup mode, the above example command works from the root
downwards and is thus equivalent to ls -type mesh.
Flags:
- absoluteName : an (bool) [create,query]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent
namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not.
- addNamespace : add (unicode) [create]
Create a new namespace with the given name. Both qualified names (A:B) and unqualified names (A) are acceptable. If any
of the higher-level namespaces in a qualified name do not yet exist, they will be created. If the supplied name contains
invalid characters it will first be modified as per the validateName flag.
- collapseAncestors : ch (unicode) [create]
Delete all empty ancestors of the given namespace. An empty namespace is a a namespace that does not contain any objects
or other nested namespaces
- deleteNamespaceContent : dnc (bool) [create]
Used with the 'rm/removeNamespace' flag to indicate that when removing a namespace the contents of the namespace will
also be removed.
- exists : ex (unicode) [query]
Returns true if the specified namespace exists, false if not.
- force : f (bool) [create]
Used with 'mv/moveNamespace' to force the move operation to ignore name clashes.
- isRootNamespace : ir (unicode) [query]
Returns true if the specified namespace is root, false if not.
- mergeNamespaceWithParent : mnp (bool) [create]
Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the parent
namespace.
- mergeNamespaceWithRoot : mnr (bool) [create]
Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the root
namespace.
- moveNamespace : mv (unicode, unicode) [create]
Move the contents of the first namespace into the second namespace. Child namespaces will also be moved. Attempting to
move a namespace containing referenced nodes will result in an error; use the 'file' command ('file -edit -namespace')
to change a reference namespace. If there are objects in the source namespace with the same name as objects in the
destination namespace, an error will be issued. Use the 'force' flag to override this error - name clashes will be
resolved by renaming the objects to ensure uniqueness.
- parent : p (unicode) [create]
Used with the 'addNamespace' or 'rename' flags to specifiy the parent of the new namespace. The full namespace parent
path is required. When using 'addNamespace' with an absolute name, the 'parent' will be ignored and the command will
display a warning
- recurse : r (bool) [query]
Can be used with the 'exists' flag to recursively look for the specified namespace
- relativeNames : rel (bool) [create,query]
Turns on relative name lookup, which causes name lookups within Maya to be relative to the current namespace. By default
this is off, meaning that name lookups are always relative to the root namespace. Be careful turning this feature on
since commands such as setAttr will behave differently. It is wise to only turn this feature on while executing custom
procedures that you have written to be namespace independent and turning relativeNames off when returning control from
your custom procedures. Note that Maya will turn on relative naming during file I/O. Although it is not recommended to
leave relativeNames turned on, if you try to toggle the value during file I/O you may notice that the value stays
onbecause Maya has already temporarily enabled it internally. When relativeNames are enabled, the returns provided by
the 'ls' command will be relative to the current namespace. See the main description of this command for more details.
- removeNamespace : rm (unicode) [create]
Deletes the given namespace. The namespace must be empty for it to be deleted.
- rename : ren (unicode, unicode) [create]
Rename the first namespace to second namespace name. Child namespaces will also be renamed. Both names are relative to
the current namespace. Use the 'parent' flag to specify a parent namespace for the renamed namespace. An error is issued
if the second namespace name already exists. If the supplied name contains invalid characters it will first be modified
as per the validateName flag.
- setNamespace : set (unicode) [create]
Sets the current namespace.
- validateName : vn (unicode) [create]
Convert the specified name to a valid name to make it contain no illegal characters. The leading illegal characters will
be removed and other illegal characters will be converted to '_'. Specially, the leading numeric characters and trailing
space characters will be also removed. Full name path can be validated as well. However, if the namespace of the path
does not exist, command will only return the base name. For example, :nonExistentNS:namewill be converted to name. If
the entire name consists solely of illegal characters, e.g. 123which contains only leading digits, then the returned
string will be empty. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.namespace`
|
mayaSDK/pymel/core/system.py
|
namespace
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def namespace(*args, **kwargs):
"\n This command allows a namespace to be created, set or removed. A namespace is a simple grouping of objects under a given\n name. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the same name as an\n existing object (from importing a file, for example). Using namespaces, you can have two objects with the same name, as\n long as they are contained in differenct namespaces. Namespaces are reminiscent of hierarchical structures like file\n systems where namespaces are analogous to directories and objects are analogous to files. The colon (':') character is\n the separator used to separate the names of namespaces and nodes instead of the slash ('/') or backslash ()\n character. Namespaces can contain other namespaces as well as objects. Like objects, the names of namespaces must be\n unique within another namespace. Objects and namespaces can be in only one namespace. Namespace names and object names\n don't clash so a namespace and an object contained in another namespace can have the same name. There is an unnamed root\n namespace specified with a leading colon (':'). Any object not in a named namespace is in the root namespace. Normally,\n the leading colon is omitted from the name of an object as it's presence is implied. The presence of a leading colon is\n important when moving objects between namespaces using the 'rename' command. For the 'rename' command, the new name is\n relative to the current namespace unless the new name is fully qualified with a leading colon. Namespaces are created\n using the 'add/addNamespace' flag. By default they are created under the current namespace. Changing the current\n namespace is done with the 'set/setNamespace' flag. To reset the current namespace to the root namespace, use 'namespace\n -set :;'. Whenever an object is created, it is added by default to the current namespace. When creating a new namespace\n using a qualified name, any intervening namespaces which do not yet exist will be automatically created. For example, if\n the name of the new namespace is specified as A:Band the current namespace already has a child namespace named Athen a\n new child namespace named Bwill be created under A. But if the current namespace does not yet have a child named Athen\n it will be created automatically. This applies regardless of the number of levels in the provided name (e.g. A:B:C:D).\n The 'p/parent' flag can be used to explicitly specify the parent namespace under which the new one should be created,\n rather than just defaulting to the current namespace. If the name given for the new namespace is absolute (i.e. it\n begins with a colon, as in :A:B) then both the current namespace and the 'parent' flag will be ignored and the new\n namespace will be created under the root namespace. The relativeNamespace flag can be used to change the way node names\n are displayed in the UI and returned by the 'ls' command. Here are some specific details on how the return from the 'ls'\n command works in relativeNamespace mode: List all mesh objects in the scene:ls -type mesh;The above command lists all\n mesh objects in the root and any child namespaces. In relative name lookup mode, all names will be displayed relative to\n the current namespace. When not in relative name lookup mode (the default behaviour in Maya), results are printed\n relative to the root namespace. Using a \\*wildcard:namespace -set myNS;ls -type mesh \\*;In relative name lookup mode,\n the \\*will match to the current namespace and thus the ls command will list only those meshes defined within the current\n namespace (i.e. myNs). If relative name lookup is off (the default behaviour in Maya), names are root-relative and thus\n \\*matches the root namespace, with the net result being that only thoses meshes defined in the root namespace will be\n listed. You can force the root namespace to be listed when in relative name lookup mode by specifying :\\*as your search\n pattern (i.e. ls -type mesh :\\*which lists those meshes defined in the root namespace only). Note that you can also use\n :\\*when relative name lookup mode is off to match the root if you want a consistent way to list the root. Listing child\n namespace contents:ls -type mesh \\*:\\*;For an example to list all meshes in immediate child namespaces, use \\*:\\*. In\n relative name lookup mode \\*:\\*lists those meshes in immediate child namespaces of the current namespaces. When not in\n relative name lookup mode, \\*:\\*lists meshes in namespaces one level below the root. Recursive listing of namespace\n contents:Example: ls -type mesh -recurse on \\*The 'recurse' flag is provided on the lscommand to recursively traverse\n any child namespaces. In relative name lookup mode, the above example command will list all meshes in the current and\n any child namespaces of current. When not in relative name lookup mode, the above example command works from the root\n downwards and is thus equivalent to ls -type mesh.\n \n Flags:\n - absoluteName : an (bool) [create,query]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent\n namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not.\n \n - addNamespace : add (unicode) [create]\n Create a new namespace with the given name. Both qualified names (A:B) and unqualified names (A) are acceptable. If any\n of the higher-level namespaces in a qualified name do not yet exist, they will be created. If the supplied name contains\n invalid characters it will first be modified as per the validateName flag.\n \n - collapseAncestors : ch (unicode) [create]\n Delete all empty ancestors of the given namespace. An empty namespace is a a namespace that does not contain any objects\n or other nested namespaces\n \n - deleteNamespaceContent : dnc (bool) [create]\n Used with the 'rm/removeNamespace' flag to indicate that when removing a namespace the contents of the namespace will\n also be removed.\n \n - exists : ex (unicode) [query]\n Returns true if the specified namespace exists, false if not.\n \n - force : f (bool) [create]\n Used with 'mv/moveNamespace' to force the move operation to ignore name clashes.\n \n - isRootNamespace : ir (unicode) [query]\n Returns true if the specified namespace is root, false if not.\n \n - mergeNamespaceWithParent : mnp (bool) [create]\n Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the parent\n namespace.\n \n - mergeNamespaceWithRoot : mnr (bool) [create]\n Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the root\n namespace.\n \n - moveNamespace : mv (unicode, unicode) [create]\n Move the contents of the first namespace into the second namespace. Child namespaces will also be moved. Attempting to\n move a namespace containing referenced nodes will result in an error; use the 'file' command ('file -edit -namespace')\n to change a reference namespace. If there are objects in the source namespace with the same name as objects in the\n destination namespace, an error will be issued. Use the 'force' flag to override this error - name clashes will be\n resolved by renaming the objects to ensure uniqueness.\n \n - parent : p (unicode) [create]\n Used with the 'addNamespace' or 'rename' flags to specifiy the parent of the new namespace. The full namespace parent\n path is required. When using 'addNamespace' with an absolute name, the 'parent' will be ignored and the command will\n display a warning\n \n - recurse : r (bool) [query]\n Can be used with the 'exists' flag to recursively look for the specified namespace\n \n - relativeNames : rel (bool) [create,query]\n Turns on relative name lookup, which causes name lookups within Maya to be relative to the current namespace. By default\n this is off, meaning that name lookups are always relative to the root namespace. Be careful turning this feature on\n since commands such as setAttr will behave differently. It is wise to only turn this feature on while executing custom\n procedures that you have written to be namespace independent and turning relativeNames off when returning control from\n your custom procedures. Note that Maya will turn on relative naming during file I/O. Although it is not recommended to\n leave relativeNames turned on, if you try to toggle the value during file I/O you may notice that the value stays\n onbecause Maya has already temporarily enabled it internally. When relativeNames are enabled, the returns provided by\n the 'ls' command will be relative to the current namespace. See the main description of this command for more details.\n \n - removeNamespace : rm (unicode) [create]\n Deletes the given namespace. The namespace must be empty for it to be deleted.\n \n - rename : ren (unicode, unicode) [create]\n Rename the first namespace to second namespace name. Child namespaces will also be renamed. Both names are relative to\n the current namespace. Use the 'parent' flag to specify a parent namespace for the renamed namespace. An error is issued\n if the second namespace name already exists. If the supplied name contains invalid characters it will first be modified\n as per the validateName flag.\n \n - setNamespace : set (unicode) [create]\n Sets the current namespace.\n \n - validateName : vn (unicode) [create]\n Convert the specified name to a valid name to make it contain no illegal characters. The leading illegal characters will\n be removed and other illegal characters will be converted to '_'. Specially, the leading numeric characters and trailing\n space characters will be also removed. Full name path can be validated as well. However, if the namespace of the path\n does not exist, command will only return the base name. For example, :nonExistentNS:namewill be converted to name. If\n the entire name consists solely of illegal characters, e.g. 123which contains only leading digits, then the returned\n string will be empty. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.namespace`\n "
pass
|
def namespace(*args, **kwargs):
"\n This command allows a namespace to be created, set or removed. A namespace is a simple grouping of objects under a given\n name. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the same name as an\n existing object (from importing a file, for example). Using namespaces, you can have two objects with the same name, as\n long as they are contained in differenct namespaces. Namespaces are reminiscent of hierarchical structures like file\n systems where namespaces are analogous to directories and objects are analogous to files. The colon (':') character is\n the separator used to separate the names of namespaces and nodes instead of the slash ('/') or backslash ()\n character. Namespaces can contain other namespaces as well as objects. Like objects, the names of namespaces must be\n unique within another namespace. Objects and namespaces can be in only one namespace. Namespace names and object names\n don't clash so a namespace and an object contained in another namespace can have the same name. There is an unnamed root\n namespace specified with a leading colon (':'). Any object not in a named namespace is in the root namespace. Normally,\n the leading colon is omitted from the name of an object as it's presence is implied. The presence of a leading colon is\n important when moving objects between namespaces using the 'rename' command. For the 'rename' command, the new name is\n relative to the current namespace unless the new name is fully qualified with a leading colon. Namespaces are created\n using the 'add/addNamespace' flag. By default they are created under the current namespace. Changing the current\n namespace is done with the 'set/setNamespace' flag. To reset the current namespace to the root namespace, use 'namespace\n -set :;'. Whenever an object is created, it is added by default to the current namespace. When creating a new namespace\n using a qualified name, any intervening namespaces which do not yet exist will be automatically created. For example, if\n the name of the new namespace is specified as A:Band the current namespace already has a child namespace named Athen a\n new child namespace named Bwill be created under A. But if the current namespace does not yet have a child named Athen\n it will be created automatically. This applies regardless of the number of levels in the provided name (e.g. A:B:C:D).\n The 'p/parent' flag can be used to explicitly specify the parent namespace under which the new one should be created,\n rather than just defaulting to the current namespace. If the name given for the new namespace is absolute (i.e. it\n begins with a colon, as in :A:B) then both the current namespace and the 'parent' flag will be ignored and the new\n namespace will be created under the root namespace. The relativeNamespace flag can be used to change the way node names\n are displayed in the UI and returned by the 'ls' command. Here are some specific details on how the return from the 'ls'\n command works in relativeNamespace mode: List all mesh objects in the scene:ls -type mesh;The above command lists all\n mesh objects in the root and any child namespaces. In relative name lookup mode, all names will be displayed relative to\n the current namespace. When not in relative name lookup mode (the default behaviour in Maya), results are printed\n relative to the root namespace. Using a \\*wildcard:namespace -set myNS;ls -type mesh \\*;In relative name lookup mode,\n the \\*will match to the current namespace and thus the ls command will list only those meshes defined within the current\n namespace (i.e. myNs). If relative name lookup is off (the default behaviour in Maya), names are root-relative and thus\n \\*matches the root namespace, with the net result being that only thoses meshes defined in the root namespace will be\n listed. You can force the root namespace to be listed when in relative name lookup mode by specifying :\\*as your search\n pattern (i.e. ls -type mesh :\\*which lists those meshes defined in the root namespace only). Note that you can also use\n :\\*when relative name lookup mode is off to match the root if you want a consistent way to list the root. Listing child\n namespace contents:ls -type mesh \\*:\\*;For an example to list all meshes in immediate child namespaces, use \\*:\\*. In\n relative name lookup mode \\*:\\*lists those meshes in immediate child namespaces of the current namespaces. When not in\n relative name lookup mode, \\*:\\*lists meshes in namespaces one level below the root. Recursive listing of namespace\n contents:Example: ls -type mesh -recurse on \\*The 'recurse' flag is provided on the lscommand to recursively traverse\n any child namespaces. In relative name lookup mode, the above example command will list all meshes in the current and\n any child namespaces of current. When not in relative name lookup mode, the above example command works from the root\n downwards and is thus equivalent to ls -type mesh.\n \n Flags:\n - absoluteName : an (bool) [create,query]\n This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The\n absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent\n namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not.\n \n - addNamespace : add (unicode) [create]\n Create a new namespace with the given name. Both qualified names (A:B) and unqualified names (A) are acceptable. If any\n of the higher-level namespaces in a qualified name do not yet exist, they will be created. If the supplied name contains\n invalid characters it will first be modified as per the validateName flag.\n \n - collapseAncestors : ch (unicode) [create]\n Delete all empty ancestors of the given namespace. An empty namespace is a a namespace that does not contain any objects\n or other nested namespaces\n \n - deleteNamespaceContent : dnc (bool) [create]\n Used with the 'rm/removeNamespace' flag to indicate that when removing a namespace the contents of the namespace will\n also be removed.\n \n - exists : ex (unicode) [query]\n Returns true if the specified namespace exists, false if not.\n \n - force : f (bool) [create]\n Used with 'mv/moveNamespace' to force the move operation to ignore name clashes.\n \n - isRootNamespace : ir (unicode) [query]\n Returns true if the specified namespace is root, false if not.\n \n - mergeNamespaceWithParent : mnp (bool) [create]\n Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the parent\n namespace.\n \n - mergeNamespaceWithRoot : mnr (bool) [create]\n Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the root\n namespace.\n \n - moveNamespace : mv (unicode, unicode) [create]\n Move the contents of the first namespace into the second namespace. Child namespaces will also be moved. Attempting to\n move a namespace containing referenced nodes will result in an error; use the 'file' command ('file -edit -namespace')\n to change a reference namespace. If there are objects in the source namespace with the same name as objects in the\n destination namespace, an error will be issued. Use the 'force' flag to override this error - name clashes will be\n resolved by renaming the objects to ensure uniqueness.\n \n - parent : p (unicode) [create]\n Used with the 'addNamespace' or 'rename' flags to specifiy the parent of the new namespace. The full namespace parent\n path is required. When using 'addNamespace' with an absolute name, the 'parent' will be ignored and the command will\n display a warning\n \n - recurse : r (bool) [query]\n Can be used with the 'exists' flag to recursively look for the specified namespace\n \n - relativeNames : rel (bool) [create,query]\n Turns on relative name lookup, which causes name lookups within Maya to be relative to the current namespace. By default\n this is off, meaning that name lookups are always relative to the root namespace. Be careful turning this feature on\n since commands such as setAttr will behave differently. It is wise to only turn this feature on while executing custom\n procedures that you have written to be namespace independent and turning relativeNames off when returning control from\n your custom procedures. Note that Maya will turn on relative naming during file I/O. Although it is not recommended to\n leave relativeNames turned on, if you try to toggle the value during file I/O you may notice that the value stays\n onbecause Maya has already temporarily enabled it internally. When relativeNames are enabled, the returns provided by\n the 'ls' command will be relative to the current namespace. See the main description of this command for more details.\n \n - removeNamespace : rm (unicode) [create]\n Deletes the given namespace. The namespace must be empty for it to be deleted.\n \n - rename : ren (unicode, unicode) [create]\n Rename the first namespace to second namespace name. Child namespaces will also be renamed. Both names are relative to\n the current namespace. Use the 'parent' flag to specify a parent namespace for the renamed namespace. An error is issued\n if the second namespace name already exists. If the supplied name contains invalid characters it will first be modified\n as per the validateName flag.\n \n - setNamespace : set (unicode) [create]\n Sets the current namespace.\n \n - validateName : vn (unicode) [create]\n Convert the specified name to a valid name to make it contain no illegal characters. The leading illegal characters will\n be removed and other illegal characters will be converted to '_'. Specially, the leading numeric characters and trailing\n space characters will be also removed. Full name path can be validated as well. However, if the namespace of the path\n does not exist, command will only return the base name. For example, :nonExistentNS:namewill be converted to name. If\n the entire name consists solely of illegal characters, e.g. 123which contains only leading digits, then the returned\n string will be empty. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.namespace`\n "
pass<|docstring|>This command allows a namespace to be created, set or removed. A namespace is a simple grouping of objects under a given
name. Namespaces are primarily used to resolve name-clash issues in Maya, where a new object has the same name as an
existing object (from importing a file, for example). Using namespaces, you can have two objects with the same name, as
long as they are contained in differenct namespaces. Namespaces are reminiscent of hierarchical structures like file
systems where namespaces are analogous to directories and objects are analogous to files. The colon (':') character is
the separator used to separate the names of namespaces and nodes instead of the slash ('/') or backslash ('')
character. Namespaces can contain other namespaces as well as objects. Like objects, the names of namespaces must be
unique within another namespace. Objects and namespaces can be in only one namespace. Namespace names and object names
don't clash so a namespace and an object contained in another namespace can have the same name. There is an unnamed root
namespace specified with a leading colon (':'). Any object not in a named namespace is in the root namespace. Normally,
the leading colon is omitted from the name of an object as it's presence is implied. The presence of a leading colon is
important when moving objects between namespaces using the 'rename' command. For the 'rename' command, the new name is
relative to the current namespace unless the new name is fully qualified with a leading colon. Namespaces are created
using the 'add/addNamespace' flag. By default they are created under the current namespace. Changing the current
namespace is done with the 'set/setNamespace' flag. To reset the current namespace to the root namespace, use 'namespace
-set :;'. Whenever an object is created, it is added by default to the current namespace. When creating a new namespace
using a qualified name, any intervening namespaces which do not yet exist will be automatically created. For example, if
the name of the new namespace is specified as A:Band the current namespace already has a child namespace named Athen a
new child namespace named Bwill be created under A. But if the current namespace does not yet have a child named Athen
it will be created automatically. This applies regardless of the number of levels in the provided name (e.g. A:B:C:D).
The 'p/parent' flag can be used to explicitly specify the parent namespace under which the new one should be created,
rather than just defaulting to the current namespace. If the name given for the new namespace is absolute (i.e. it
begins with a colon, as in :A:B) then both the current namespace and the 'parent' flag will be ignored and the new
namespace will be created under the root namespace. The relativeNamespace flag can be used to change the way node names
are displayed in the UI and returned by the 'ls' command. Here are some specific details on how the return from the 'ls'
command works in relativeNamespace mode: List all mesh objects in the scene:ls -type mesh;The above command lists all
mesh objects in the root and any child namespaces. In relative name lookup mode, all names will be displayed relative to
the current namespace. When not in relative name lookup mode (the default behaviour in Maya), results are printed
relative to the root namespace. Using a \*wildcard:namespace -set myNS;ls -type mesh \*;In relative name lookup mode,
the \*will match to the current namespace and thus the ls command will list only those meshes defined within the current
namespace (i.e. myNs). If relative name lookup is off (the default behaviour in Maya), names are root-relative and thus
\*matches the root namespace, with the net result being that only thoses meshes defined in the root namespace will be
listed. You can force the root namespace to be listed when in relative name lookup mode by specifying :\*as your search
pattern (i.e. ls -type mesh :\*which lists those meshes defined in the root namespace only). Note that you can also use
:\*when relative name lookup mode is off to match the root if you want a consistent way to list the root. Listing child
namespace contents:ls -type mesh \*:\*;For an example to list all meshes in immediate child namespaces, use \*:\*. In
relative name lookup mode \*:\*lists those meshes in immediate child namespaces of the current namespaces. When not in
relative name lookup mode, \*:\*lists meshes in namespaces one level below the root. Recursive listing of namespace
contents:Example: ls -type mesh -recurse on \*The 'recurse' flag is provided on the lscommand to recursively traverse
any child namespaces. In relative name lookup mode, the above example command will list all meshes in the current and
any child namespaces of current. When not in relative name lookup mode, the above example command works from the root
downwards and is thus equivalent to ls -type mesh.
Flags:
- absoluteName : an (bool) [create,query]
This is a general flag which can be used to specify the desired format for the namespace(s) returned by the command. The
absolute name of the namespace is a full namespace path, starting from the root namespace :and including all parent
namespaces. For example :ns:ballis an absolute namespace name while ns:ballis not.
- addNamespace : add (unicode) [create]
Create a new namespace with the given name. Both qualified names (A:B) and unqualified names (A) are acceptable. If any
of the higher-level namespaces in a qualified name do not yet exist, they will be created. If the supplied name contains
invalid characters it will first be modified as per the validateName flag.
- collapseAncestors : ch (unicode) [create]
Delete all empty ancestors of the given namespace. An empty namespace is a a namespace that does not contain any objects
or other nested namespaces
- deleteNamespaceContent : dnc (bool) [create]
Used with the 'rm/removeNamespace' flag to indicate that when removing a namespace the contents of the namespace will
also be removed.
- exists : ex (unicode) [query]
Returns true if the specified namespace exists, false if not.
- force : f (bool) [create]
Used with 'mv/moveNamespace' to force the move operation to ignore name clashes.
- isRootNamespace : ir (unicode) [query]
Returns true if the specified namespace is root, false if not.
- mergeNamespaceWithParent : mnp (bool) [create]
Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the parent
namespace.
- mergeNamespaceWithRoot : mnr (bool) [create]
Used with the 'rm/removeNamespace' flag. When removing a namespace, move the rest of the namespace content to the root
namespace.
- moveNamespace : mv (unicode, unicode) [create]
Move the contents of the first namespace into the second namespace. Child namespaces will also be moved. Attempting to
move a namespace containing referenced nodes will result in an error; use the 'file' command ('file -edit -namespace')
to change a reference namespace. If there are objects in the source namespace with the same name as objects in the
destination namespace, an error will be issued. Use the 'force' flag to override this error - name clashes will be
resolved by renaming the objects to ensure uniqueness.
- parent : p (unicode) [create]
Used with the 'addNamespace' or 'rename' flags to specifiy the parent of the new namespace. The full namespace parent
path is required. When using 'addNamespace' with an absolute name, the 'parent' will be ignored and the command will
display a warning
- recurse : r (bool) [query]
Can be used with the 'exists' flag to recursively look for the specified namespace
- relativeNames : rel (bool) [create,query]
Turns on relative name lookup, which causes name lookups within Maya to be relative to the current namespace. By default
this is off, meaning that name lookups are always relative to the root namespace. Be careful turning this feature on
since commands such as setAttr will behave differently. It is wise to only turn this feature on while executing custom
procedures that you have written to be namespace independent and turning relativeNames off when returning control from
your custom procedures. Note that Maya will turn on relative naming during file I/O. Although it is not recommended to
leave relativeNames turned on, if you try to toggle the value during file I/O you may notice that the value stays
onbecause Maya has already temporarily enabled it internally. When relativeNames are enabled, the returns provided by
the 'ls' command will be relative to the current namespace. See the main description of this command for more details.
- removeNamespace : rm (unicode) [create]
Deletes the given namespace. The namespace must be empty for it to be deleted.
- rename : ren (unicode, unicode) [create]
Rename the first namespace to second namespace name. Child namespaces will also be renamed. Both names are relative to
the current namespace. Use the 'parent' flag to specify a parent namespace for the renamed namespace. An error is issued
if the second namespace name already exists. If the supplied name contains invalid characters it will first be modified
as per the validateName flag.
- setNamespace : set (unicode) [create]
Sets the current namespace.
- validateName : vn (unicode) [create]
Convert the specified name to a valid name to make it contain no illegal characters. The leading illegal characters will
be removed and other illegal characters will be converted to '_'. Specially, the leading numeric characters and trailing
space characters will be also removed. Full name path can be validated as well. However, if the namespace of the path
does not exist, command will only return the base name. For example, :nonExistentNS:namewill be converted to name. If
the entire name consists solely of illegal characters, e.g. 123which contains only leading digits, then the returned
string will be empty. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.namespace`<|endoftext|>
|
43b78a465f82b492a932fd3e01af7db9fc726e649caa5d13b0b813024e1a5371
|
def exportSelectedAnim(exportPath, **kwargs):
'\n Export all animation nodes and animation helper nodes from the selected objects in the scene. See -ean/exportAnim flag description for details on usage of animation files. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Export all animation nodes and animation helper nodes from the selected objects in the scene. See -ean/exportAnim flag description for details on usage of animation files.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
exportSelectedAnim
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def exportSelectedAnim(exportPath, **kwargs):
'\n Export all animation nodes and animation helper nodes from the selected objects in the scene. See -ean/exportAnim flag description for details on usage of animation files. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def exportSelectedAnim(exportPath, **kwargs):
'\n Export all animation nodes and animation helper nodes from the selected objects in the scene. See -ean/exportAnim flag description for details on usage of animation files. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Export all animation nodes and animation helper nodes from the selected objects in the scene. See -ean/exportAnim flag description for details on usage of animation files.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
210598f06cd77cd7d9a55289a5ec2f2731f420cb1c95035f40b971edfe953213
|
def reloadImage(*args, **kwargs):
'\n This command reloads an xpm image from disk. This can be used when the file has changed on disk and needs to be\n reloaded. The first string argument is the file name of the .xpm file. The second string argument is the name of a\n control using the specified pixmap.\n \n \n Derived from mel command `maya.cmds.reloadImage`\n '
pass
|
This command reloads an xpm image from disk. This can be used when the file has changed on disk and needs to be
reloaded. The first string argument is the file name of the .xpm file. The second string argument is the name of a
control using the specified pixmap.
Derived from mel command `maya.cmds.reloadImage`
|
mayaSDK/pymel/core/system.py
|
reloadImage
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def reloadImage(*args, **kwargs):
'\n This command reloads an xpm image from disk. This can be used when the file has changed on disk and needs to be\n reloaded. The first string argument is the file name of the .xpm file. The second string argument is the name of a\n control using the specified pixmap.\n \n \n Derived from mel command `maya.cmds.reloadImage`\n '
pass
|
def reloadImage(*args, **kwargs):
'\n This command reloads an xpm image from disk. This can be used when the file has changed on disk and needs to be\n reloaded. The first string argument is the file name of the .xpm file. The second string argument is the name of a\n control using the specified pixmap.\n \n \n Derived from mel command `maya.cmds.reloadImage`\n '
pass<|docstring|>This command reloads an xpm image from disk. This can be used when the file has changed on disk and needs to be
reloaded. The first string argument is the file name of the .xpm file. The second string argument is the name of a
control using the specified pixmap.
Derived from mel command `maya.cmds.reloadImage`<|endoftext|>
|
5f814889ab11bbe30ef02ba10e460a28332233ea0cdec6eab2f694d1c13e699e
|
def selLoadSettings(*args, **kwargs):
"\n This command is used to edit and query information about the implicit load settings. Currently this is primarily\n intended for internal use within the Preload Reference Editor. selLoadSettings acts on load setting IDs. When implict\n load settings are built for a target scene, there will be one load setting for each reference in the target scene. Each\n load setting has a numerical ID which is its index in a pre-order traversal of the target reference hierarchy (with the\n root scenefile being assigned an ID of 0). Although the IDs are numerical they must be passed to the command as string\n array. Example: Given the scene: a / \\ b c / \\ d e where: a references b and c c\n references d and e the IDs will be as follows: a = 0 b = 1 c = 2 d = 3 e = 4 selLoadSettings can be used to change the\n load state of a reference: whether it will be loaded or unloaded (deferred) when the target scene is opened. Note:\n selLoadSettings can accept multiple command parameters, but the order must be selected carefully such that no reference\n is set to the loaded state while its parent is in the unlaoded state. Given the scene: a | b [-] | c [-] where: a\n references b b references c a = 0 b = 1 c = 2 and b and c are currently in the unloaded state. The following command\n will succeed and change both b and c to the loaded state: selLoadSettings -e -deferReference 0 12; whereas the following\n command will fail and leave both b and c in the unloaded state: selLoadSettings -e -deferReference 0 21; Bear in mind\n that the following command will also change both b and c to the loaded state: selLoadSettings -e -deferReference 0 1;\n This is because setting a reference to the loaded state automatically sets all child references to the loaded state as\n well. And vice versa, setting a reference the the unloaded state automatically sets all child reference to the unloaded\n state.\n \n Flags:\n - activeProxy : ap (unicode) [create,query,edit]\n Change or query the active proxy of a proxy set. In query mode, returns the proxyTag of the active proxy; in edit mode,\n finds the proxy in the proxySet with the given tag and makes it the active proxy.\n \n - deferReference : dr (bool) [create,query,edit]\n Change or query the load state of a reference.\n \n - fileName : fn (unicode) [create,query]\n Return the file name reference file(s) associated with the indicated load setting(s).\n \n - numSettings : ns (int) [create,query]\n Return the number of settings in the group of implicit load settings. This is equivalent to number of references in the\n scene plus 1.\n \n - proxyManager : pm (unicode) [create,query]\n Return the name(s) of the proxy manager(s) associated with the indicated load setting(s).\n \n - proxySetFiles : psf (unicode) [create,query]\n Return the name(s) of the proxy(ies) available in the proxy set associated with the indicated load setting(s).\n \n - proxySetTags : pst (unicode) [create,query]\n Return the name(s) of the proxy tag(s) available in the proxy set associated with the indicated load setting(s).\n \n - proxyTag : pt (unicode) [create,query]\n Return the name(s) of the proxy tag(s) associated with the indicated load setting(s).\n \n - referenceNode : rfn (unicode) [create,query]\n Return the name(s) of the reference node(s) associated with the indicated load setting(s).\n \n - shortName : shn (bool) [create,query]\n Formats the return value of the 'fileName' query flag to only return the short name(s) of the reference file(s).\n \n - unresolvedName : un (bool) [create,query]\n Formats the return value of the 'fileName' query flag to return the unresolved name(s) of the reference file(s). The\n unresolved file name is the file name used when the reference was created, whether or not that file actually exists on\n disk. When Maya encounters a file name which does not exist on disk it attempts to resolve the name by looking for the\n file in a number of other locations. By default the 'fileName' flag will return this resolved value.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.selLoadSettings`\n "
pass
|
This command is used to edit and query information about the implicit load settings. Currently this is primarily
intended for internal use within the Preload Reference Editor. selLoadSettings acts on load setting IDs. When implict
load settings are built for a target scene, there will be one load setting for each reference in the target scene. Each
load setting has a numerical ID which is its index in a pre-order traversal of the target reference hierarchy (with the
root scenefile being assigned an ID of 0). Although the IDs are numerical they must be passed to the command as string
array. Example: Given the scene: a / \ b c / \ d e where: a references b and c c
references d and e the IDs will be as follows: a = 0 b = 1 c = 2 d = 3 e = 4 selLoadSettings can be used to change the
load state of a reference: whether it will be loaded or unloaded (deferred) when the target scene is opened. Note:
selLoadSettings can accept multiple command parameters, but the order must be selected carefully such that no reference
is set to the loaded state while its parent is in the unlaoded state. Given the scene: a | b [-] | c [-] where: a
references b b references c a = 0 b = 1 c = 2 and b and c are currently in the unloaded state. The following command
will succeed and change both b and c to the loaded state: selLoadSettings -e -deferReference 0 12; whereas the following
command will fail and leave both b and c in the unloaded state: selLoadSettings -e -deferReference 0 21; Bear in mind
that the following command will also change both b and c to the loaded state: selLoadSettings -e -deferReference 0 1;
This is because setting a reference to the loaded state automatically sets all child references to the loaded state as
well. And vice versa, setting a reference the the unloaded state automatically sets all child reference to the unloaded
state.
Flags:
- activeProxy : ap (unicode) [create,query,edit]
Change or query the active proxy of a proxy set. In query mode, returns the proxyTag of the active proxy; in edit mode,
finds the proxy in the proxySet with the given tag and makes it the active proxy.
- deferReference : dr (bool) [create,query,edit]
Change or query the load state of a reference.
- fileName : fn (unicode) [create,query]
Return the file name reference file(s) associated with the indicated load setting(s).
- numSettings : ns (int) [create,query]
Return the number of settings in the group of implicit load settings. This is equivalent to number of references in the
scene plus 1.
- proxyManager : pm (unicode) [create,query]
Return the name(s) of the proxy manager(s) associated with the indicated load setting(s).
- proxySetFiles : psf (unicode) [create,query]
Return the name(s) of the proxy(ies) available in the proxy set associated with the indicated load setting(s).
- proxySetTags : pst (unicode) [create,query]
Return the name(s) of the proxy tag(s) available in the proxy set associated with the indicated load setting(s).
- proxyTag : pt (unicode) [create,query]
Return the name(s) of the proxy tag(s) associated with the indicated load setting(s).
- referenceNode : rfn (unicode) [create,query]
Return the name(s) of the reference node(s) associated with the indicated load setting(s).
- shortName : shn (bool) [create,query]
Formats the return value of the 'fileName' query flag to only return the short name(s) of the reference file(s).
- unresolvedName : un (bool) [create,query]
Formats the return value of the 'fileName' query flag to return the unresolved name(s) of the reference file(s). The
unresolved file name is the file name used when the reference was created, whether or not that file actually exists on
disk. When Maya encounters a file name which does not exist on disk it attempts to resolve the name by looking for the
file in a number of other locations. By default the 'fileName' flag will return this resolved value.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.selLoadSettings`
|
mayaSDK/pymel/core/system.py
|
selLoadSettings
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def selLoadSettings(*args, **kwargs):
"\n This command is used to edit and query information about the implicit load settings. Currently this is primarily\n intended for internal use within the Preload Reference Editor. selLoadSettings acts on load setting IDs. When implict\n load settings are built for a target scene, there will be one load setting for each reference in the target scene. Each\n load setting has a numerical ID which is its index in a pre-order traversal of the target reference hierarchy (with the\n root scenefile being assigned an ID of 0). Although the IDs are numerical they must be passed to the command as string\n array. Example: Given the scene: a / \\ b c / \\ d e where: a references b and c c\n references d and e the IDs will be as follows: a = 0 b = 1 c = 2 d = 3 e = 4 selLoadSettings can be used to change the\n load state of a reference: whether it will be loaded or unloaded (deferred) when the target scene is opened. Note:\n selLoadSettings can accept multiple command parameters, but the order must be selected carefully such that no reference\n is set to the loaded state while its parent is in the unlaoded state. Given the scene: a | b [-] | c [-] where: a\n references b b references c a = 0 b = 1 c = 2 and b and c are currently in the unloaded state. The following command\n will succeed and change both b and c to the loaded state: selLoadSettings -e -deferReference 0 12; whereas the following\n command will fail and leave both b and c in the unloaded state: selLoadSettings -e -deferReference 0 21; Bear in mind\n that the following command will also change both b and c to the loaded state: selLoadSettings -e -deferReference 0 1;\n This is because setting a reference to the loaded state automatically sets all child references to the loaded state as\n well. And vice versa, setting a reference the the unloaded state automatically sets all child reference to the unloaded\n state.\n \n Flags:\n - activeProxy : ap (unicode) [create,query,edit]\n Change or query the active proxy of a proxy set. In query mode, returns the proxyTag of the active proxy; in edit mode,\n finds the proxy in the proxySet with the given tag and makes it the active proxy.\n \n - deferReference : dr (bool) [create,query,edit]\n Change or query the load state of a reference.\n \n - fileName : fn (unicode) [create,query]\n Return the file name reference file(s) associated with the indicated load setting(s).\n \n - numSettings : ns (int) [create,query]\n Return the number of settings in the group of implicit load settings. This is equivalent to number of references in the\n scene plus 1.\n \n - proxyManager : pm (unicode) [create,query]\n Return the name(s) of the proxy manager(s) associated with the indicated load setting(s).\n \n - proxySetFiles : psf (unicode) [create,query]\n Return the name(s) of the proxy(ies) available in the proxy set associated with the indicated load setting(s).\n \n - proxySetTags : pst (unicode) [create,query]\n Return the name(s) of the proxy tag(s) available in the proxy set associated with the indicated load setting(s).\n \n - proxyTag : pt (unicode) [create,query]\n Return the name(s) of the proxy tag(s) associated with the indicated load setting(s).\n \n - referenceNode : rfn (unicode) [create,query]\n Return the name(s) of the reference node(s) associated with the indicated load setting(s).\n \n - shortName : shn (bool) [create,query]\n Formats the return value of the 'fileName' query flag to only return the short name(s) of the reference file(s).\n \n - unresolvedName : un (bool) [create,query]\n Formats the return value of the 'fileName' query flag to return the unresolved name(s) of the reference file(s). The\n unresolved file name is the file name used when the reference was created, whether or not that file actually exists on\n disk. When Maya encounters a file name which does not exist on disk it attempts to resolve the name by looking for the\n file in a number of other locations. By default the 'fileName' flag will return this resolved value.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.selLoadSettings`\n "
pass
|
def selLoadSettings(*args, **kwargs):
"\n This command is used to edit and query information about the implicit load settings. Currently this is primarily\n intended for internal use within the Preload Reference Editor. selLoadSettings acts on load setting IDs. When implict\n load settings are built for a target scene, there will be one load setting for each reference in the target scene. Each\n load setting has a numerical ID which is its index in a pre-order traversal of the target reference hierarchy (with the\n root scenefile being assigned an ID of 0). Although the IDs are numerical they must be passed to the command as string\n array. Example: Given the scene: a / \\ b c / \\ d e where: a references b and c c\n references d and e the IDs will be as follows: a = 0 b = 1 c = 2 d = 3 e = 4 selLoadSettings can be used to change the\n load state of a reference: whether it will be loaded or unloaded (deferred) when the target scene is opened. Note:\n selLoadSettings can accept multiple command parameters, but the order must be selected carefully such that no reference\n is set to the loaded state while its parent is in the unlaoded state. Given the scene: a | b [-] | c [-] where: a\n references b b references c a = 0 b = 1 c = 2 and b and c are currently in the unloaded state. The following command\n will succeed and change both b and c to the loaded state: selLoadSettings -e -deferReference 0 12; whereas the following\n command will fail and leave both b and c in the unloaded state: selLoadSettings -e -deferReference 0 21; Bear in mind\n that the following command will also change both b and c to the loaded state: selLoadSettings -e -deferReference 0 1;\n This is because setting a reference to the loaded state automatically sets all child references to the loaded state as\n well. And vice versa, setting a reference the the unloaded state automatically sets all child reference to the unloaded\n state.\n \n Flags:\n - activeProxy : ap (unicode) [create,query,edit]\n Change or query the active proxy of a proxy set. In query mode, returns the proxyTag of the active proxy; in edit mode,\n finds the proxy in the proxySet with the given tag and makes it the active proxy.\n \n - deferReference : dr (bool) [create,query,edit]\n Change or query the load state of a reference.\n \n - fileName : fn (unicode) [create,query]\n Return the file name reference file(s) associated with the indicated load setting(s).\n \n - numSettings : ns (int) [create,query]\n Return the number of settings in the group of implicit load settings. This is equivalent to number of references in the\n scene plus 1.\n \n - proxyManager : pm (unicode) [create,query]\n Return the name(s) of the proxy manager(s) associated with the indicated load setting(s).\n \n - proxySetFiles : psf (unicode) [create,query]\n Return the name(s) of the proxy(ies) available in the proxy set associated with the indicated load setting(s).\n \n - proxySetTags : pst (unicode) [create,query]\n Return the name(s) of the proxy tag(s) available in the proxy set associated with the indicated load setting(s).\n \n - proxyTag : pt (unicode) [create,query]\n Return the name(s) of the proxy tag(s) associated with the indicated load setting(s).\n \n - referenceNode : rfn (unicode) [create,query]\n Return the name(s) of the reference node(s) associated with the indicated load setting(s).\n \n - shortName : shn (bool) [create,query]\n Formats the return value of the 'fileName' query flag to only return the short name(s) of the reference file(s).\n \n - unresolvedName : un (bool) [create,query]\n Formats the return value of the 'fileName' query flag to return the unresolved name(s) of the reference file(s). The\n unresolved file name is the file name used when the reference was created, whether or not that file actually exists on\n disk. When Maya encounters a file name which does not exist on disk it attempts to resolve the name by looking for the\n file in a number of other locations. By default the 'fileName' flag will return this resolved value.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.selLoadSettings`\n "
pass<|docstring|>This command is used to edit and query information about the implicit load settings. Currently this is primarily
intended for internal use within the Preload Reference Editor. selLoadSettings acts on load setting IDs. When implict
load settings are built for a target scene, there will be one load setting for each reference in the target scene. Each
load setting has a numerical ID which is its index in a pre-order traversal of the target reference hierarchy (with the
root scenefile being assigned an ID of 0). Although the IDs are numerical they must be passed to the command as string
array. Example: Given the scene: a / \ b c / \ d e where: a references b and c c
references d and e the IDs will be as follows: a = 0 b = 1 c = 2 d = 3 e = 4 selLoadSettings can be used to change the
load state of a reference: whether it will be loaded or unloaded (deferred) when the target scene is opened. Note:
selLoadSettings can accept multiple command parameters, but the order must be selected carefully such that no reference
is set to the loaded state while its parent is in the unlaoded state. Given the scene: a | b [-] | c [-] where: a
references b b references c a = 0 b = 1 c = 2 and b and c are currently in the unloaded state. The following command
will succeed and change both b and c to the loaded state: selLoadSettings -e -deferReference 0 12; whereas the following
command will fail and leave both b and c in the unloaded state: selLoadSettings -e -deferReference 0 21; Bear in mind
that the following command will also change both b and c to the loaded state: selLoadSettings -e -deferReference 0 1;
This is because setting a reference to the loaded state automatically sets all child references to the loaded state as
well. And vice versa, setting a reference the the unloaded state automatically sets all child reference to the unloaded
state.
Flags:
- activeProxy : ap (unicode) [create,query,edit]
Change or query the active proxy of a proxy set. In query mode, returns the proxyTag of the active proxy; in edit mode,
finds the proxy in the proxySet with the given tag and makes it the active proxy.
- deferReference : dr (bool) [create,query,edit]
Change or query the load state of a reference.
- fileName : fn (unicode) [create,query]
Return the file name reference file(s) associated with the indicated load setting(s).
- numSettings : ns (int) [create,query]
Return the number of settings in the group of implicit load settings. This is equivalent to number of references in the
scene plus 1.
- proxyManager : pm (unicode) [create,query]
Return the name(s) of the proxy manager(s) associated with the indicated load setting(s).
- proxySetFiles : psf (unicode) [create,query]
Return the name(s) of the proxy(ies) available in the proxy set associated with the indicated load setting(s).
- proxySetTags : pst (unicode) [create,query]
Return the name(s) of the proxy tag(s) available in the proxy set associated with the indicated load setting(s).
- proxyTag : pt (unicode) [create,query]
Return the name(s) of the proxy tag(s) associated with the indicated load setting(s).
- referenceNode : rfn (unicode) [create,query]
Return the name(s) of the reference node(s) associated with the indicated load setting(s).
- shortName : shn (bool) [create,query]
Formats the return value of the 'fileName' query flag to only return the short name(s) of the reference file(s).
- unresolvedName : un (bool) [create,query]
Formats the return value of the 'fileName' query flag to return the unresolved name(s) of the reference file(s). The
unresolved file name is the file name used when the reference was created, whether or not that file actually exists on
disk. When Maya encounters a file name which does not exist on disk it attempts to resolve the name by looking for the
file in a number of other locations. By default the 'fileName' flag will return this resolved value.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.selLoadSettings`<|endoftext|>
|
5be7e440159e3db31a7ed909a4461f228cb0607ff729919b9cc851d2bbc3a878
|
def listInputDevices(*args, **kwargs):
'\n This command lists all input devices that maya knows about.\n \n Dynamic library stub function\n \n \n Derived from mel command `maya.cmds.listInputDevices`\n '
pass
|
This command lists all input devices that maya knows about.
Dynamic library stub function
Derived from mel command `maya.cmds.listInputDevices`
|
mayaSDK/pymel/core/system.py
|
listInputDevices
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def listInputDevices(*args, **kwargs):
'\n This command lists all input devices that maya knows about.\n \n Dynamic library stub function\n \n \n Derived from mel command `maya.cmds.listInputDevices`\n '
pass
|
def listInputDevices(*args, **kwargs):
'\n This command lists all input devices that maya knows about.\n \n Dynamic library stub function\n \n \n Derived from mel command `maya.cmds.listInputDevices`\n '
pass<|docstring|>This command lists all input devices that maya knows about.
Dynamic library stub function
Derived from mel command `maya.cmds.listInputDevices`<|endoftext|>
|
f933e9f92a31484868dc65e1ff7c7ec852fc16002c58b2531ac65fe32eb8aad0
|
def saveFile(**kwargs):
'\n Save the specified file. Returns the name of the saved file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - preSaveScript:\n When used with the save flag, the specified script will be executed before the file is saved.\n - postSaveScript:\n When used with the save flag, the specified script will be executed after the file is saved.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Save the specified file. Returns the name of the saved file.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- preSaveScript:
When used with the save flag, the specified script will be executed before the file is saved.
- postSaveScript:
When used with the save flag, the specified script will be executed after the file is saved.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
saveFile
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def saveFile(**kwargs):
'\n Save the specified file. Returns the name of the saved file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - preSaveScript:\n When used with the save flag, the specified script will be executed before the file is saved.\n - postSaveScript:\n When used with the save flag, the specified script will be executed after the file is saved.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def saveFile(**kwargs):
'\n Save the specified file. Returns the name of the saved file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - preSaveScript:\n When used with the save flag, the specified script will be executed before the file is saved.\n - postSaveScript:\n When used with the save flag, the specified script will be executed after the file is saved.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Save the specified file. Returns the name of the saved file.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- preSaveScript:
When used with the save flag, the specified script will be executed before the file is saved.
- postSaveScript:
When used with the save flag, the specified script will be executed after the file is saved.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
d1e6b9ed7fde6c88436584da92881b7d95871d95bb3b01805cde6090148cc2bc
|
def pluginInfo(*args, **kwargs):
"\n This command provides access to the plug-in registry of the application. It is used mainly to query the characteristics\n of registered plug-ins. Plugins automatically become registered the first time that they are loaded. The argument is\n either the internal name of the plug-in or the path to access it.\n \n Flags:\n - activeFile : af (bool) [query]\n Restricts the command to the active file only, not the entire scene. This only affects the -dependNode/-dn and\n -pluginsInUse/-pu flags. For use during export selected.\n \n - animCurveInterp : aci (unicode) [query]\n Returns a string array containing the names of all of the animation curve interpolators registered by this plug-in.\n \n - apiVersion : av (bool) [query]\n Returns a string containing the version of the API that this plug-in was compiled with. See the comments in MTypes.h\n for the details on how to interpret this value.\n \n - autoload : a (bool) [create,query,edit]\n Sets whether or not this plug-in should be loaded every time the application starts up. Returns a boolean in query mode.\n \n - cacheFormat : cf (bool) [query]\n Returns a string array containing the names of all of the registered geometry cache formats\n \n - changedCommand : cc (script) [create]\n Adds a callback that will get executed every time the plug-in registry changes. Any other previously registered\n callbacks will also get called.\n \n - command : c (unicode) [query]\n Returns a string array containing the names of all of the normal commands registered by this plug-in. Constraint,\n control, context and model editor commands are not included.\n \n - constraintCommand : cnc (unicode) [query]\n Returns a string array containing the names of all of the constraint commands registered by this plug-in.\n \n - controlCommand : ctc (unicode) [query]\n Returns a string array containing the names of all of the control commands registered by this plug-in.\n \n - data : d (unicode, unicode) [query]\n Returns a string array containing the names of all of the data types registered by this plug-in.\n \n - dependNode : dn (bool) [query]\n Returns a string array containing the names of all of the custom nodes types registered by this plug-in.\n \n - dependNodeByType : dnt (unicode) [query]\n Returns a string array of all registered node types within a specified class of nodes. Each custom node type registered\n by a plug-in belongs to a more general class of node types as specified by its MPxNode::Type. The flag's argument is an\n MPxNode::Type as a string. For example, if you want to list all registered Locator nodes, you should specify\n kLocatorNode as a argument to this flag.\n \n - dependNodeId : dni (unicode) [query]\n Returns an integer array containing the ids of all of the custom node types registered by this plug-in.\n \n - device : dv (bool) [query]\n Returns a string array containing the names of all of the devices registered by this plug-in.\n \n - dragAndDropBehavior : ddb (bool) [query]\n Returns a string array containing the names of all of the drag and drop behaviors registered by this plug-in.\n \n - iksolver : ik (bool) [query]\n Returns a string array containing the names of all of the ik solvers registered by this plug-in.\n \n - listPlugins : ls (bool) [query]\n Returns a string array containing all the plug-ins that are currently loaded.\n \n - listPluginsPath : lsp (bool) [query]\n Returns a string array containing the full paths of all the plug-ins that are currently loaded.\n \n - loadPluginPrefs : lpp (bool) [create]\n Loads the plug-in preferences (ie. autoload) from pluginPrefs.mel into Maya.\n \n - loaded : l (bool) [query]\n Returns a boolean specifying whether or not the plug-in is loaded.\n \n - modelEditorCommand : mec (unicode) [query]\n Returns a string array containing the names of all of the model editor commands registered by this plug-in.\n \n - name : n (unicode) [query]\n Returns a string containing the internal name by which the plug-in is registered.\n \n - path : p (unicode) [query]\n Returns a string containing the absolute path name to the plug-in.\n \n - pluginsInUse : pu (bool) [query]\n Returns a string array containing all the plug-ins that are currently being used in the scene.\n \n - registered : r (bool) [query]\n Returns a boolean specifying whether or not plug-in is currently registered with the system.\n \n - remove : rm (bool) [edit]\n Removes the given plug-in's record from the registry. There is no return value.\n \n - renderer : rdr (bool) [query]\n Returns a string array containing the names of all of the renderers registered by this plug-in.\n \n - savePluginPrefs : spp (bool) [create]\n Saves the plug-in preferences (ie. autoload) out to pluginPrefs.mel\n \n - serviceDescriptions : sd (bool) [query]\n If there are services in use, then this flag will return a string array containing short descriptions saying what those\n services are.\n \n - settings : set (bool) [query]\n Returns an array of values with the loaded, autoload, registered flags\n \n - tool : t (unicode) [query]\n Returns a string array containing the names of all of the tool contexts registered by this plug-in.\n \n - translator : tr (bool) [query]\n Returns a string array containing the names of all of the file translators registered by this plug-in.\n \n - unloadOk : uo (bool) [query]\n Returns a boolean that specifies whether or not the plug-in can be safely unloaded. It will return false if the plug-in\n is currently in use. For example, if the plug-in adds a new dependency node type, and an instance of that node type is\n present in the scene, then this query will return false.\n \n - userNamed : u (bool) [query]\n Returns a boolean specifying whether or not the plug-in has been assigned a name by the user.\n \n - vendor : vd (unicode) [query]\n Returns a string containing the vendor of the plug-in.\n \n - version : v (bool) [query]\n Returns a string containing the version the plug-in.\n \n - writeRequires : wr (bool) [create,query,edit]\n Sets whether or not this plug-in should write requirescommand into the saved file. requirescommand could autoload the\n plug-in when you open or import that saved file. This way, Maya will load the plug-in when a file is being loaded for\n some specified reason, such as to create a customized UI or to load some plug-in data that is not saved in any node or\n attributes. For example, stereoCamerais using this flag for its customized UI. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.pluginInfo`\n "
pass
|
This command provides access to the plug-in registry of the application. It is used mainly to query the characteristics
of registered plug-ins. Plugins automatically become registered the first time that they are loaded. The argument is
either the internal name of the plug-in or the path to access it.
Flags:
- activeFile : af (bool) [query]
Restricts the command to the active file only, not the entire scene. This only affects the -dependNode/-dn and
-pluginsInUse/-pu flags. For use during export selected.
- animCurveInterp : aci (unicode) [query]
Returns a string array containing the names of all of the animation curve interpolators registered by this plug-in.
- apiVersion : av (bool) [query]
Returns a string containing the version of the API that this plug-in was compiled with. See the comments in MTypes.h
for the details on how to interpret this value.
- autoload : a (bool) [create,query,edit]
Sets whether or not this plug-in should be loaded every time the application starts up. Returns a boolean in query mode.
- cacheFormat : cf (bool) [query]
Returns a string array containing the names of all of the registered geometry cache formats
- changedCommand : cc (script) [create]
Adds a callback that will get executed every time the plug-in registry changes. Any other previously registered
callbacks will also get called.
- command : c (unicode) [query]
Returns a string array containing the names of all of the normal commands registered by this plug-in. Constraint,
control, context and model editor commands are not included.
- constraintCommand : cnc (unicode) [query]
Returns a string array containing the names of all of the constraint commands registered by this plug-in.
- controlCommand : ctc (unicode) [query]
Returns a string array containing the names of all of the control commands registered by this plug-in.
- data : d (unicode, unicode) [query]
Returns a string array containing the names of all of the data types registered by this plug-in.
- dependNode : dn (bool) [query]
Returns a string array containing the names of all of the custom nodes types registered by this plug-in.
- dependNodeByType : dnt (unicode) [query]
Returns a string array of all registered node types within a specified class of nodes. Each custom node type registered
by a plug-in belongs to a more general class of node types as specified by its MPxNode::Type. The flag's argument is an
MPxNode::Type as a string. For example, if you want to list all registered Locator nodes, you should specify
kLocatorNode as a argument to this flag.
- dependNodeId : dni (unicode) [query]
Returns an integer array containing the ids of all of the custom node types registered by this plug-in.
- device : dv (bool) [query]
Returns a string array containing the names of all of the devices registered by this plug-in.
- dragAndDropBehavior : ddb (bool) [query]
Returns a string array containing the names of all of the drag and drop behaviors registered by this plug-in.
- iksolver : ik (bool) [query]
Returns a string array containing the names of all of the ik solvers registered by this plug-in.
- listPlugins : ls (bool) [query]
Returns a string array containing all the plug-ins that are currently loaded.
- listPluginsPath : lsp (bool) [query]
Returns a string array containing the full paths of all the plug-ins that are currently loaded.
- loadPluginPrefs : lpp (bool) [create]
Loads the plug-in preferences (ie. autoload) from pluginPrefs.mel into Maya.
- loaded : l (bool) [query]
Returns a boolean specifying whether or not the plug-in is loaded.
- modelEditorCommand : mec (unicode) [query]
Returns a string array containing the names of all of the model editor commands registered by this plug-in.
- name : n (unicode) [query]
Returns a string containing the internal name by which the plug-in is registered.
- path : p (unicode) [query]
Returns a string containing the absolute path name to the plug-in.
- pluginsInUse : pu (bool) [query]
Returns a string array containing all the plug-ins that are currently being used in the scene.
- registered : r (bool) [query]
Returns a boolean specifying whether or not plug-in is currently registered with the system.
- remove : rm (bool) [edit]
Removes the given plug-in's record from the registry. There is no return value.
- renderer : rdr (bool) [query]
Returns a string array containing the names of all of the renderers registered by this plug-in.
- savePluginPrefs : spp (bool) [create]
Saves the plug-in preferences (ie. autoload) out to pluginPrefs.mel
- serviceDescriptions : sd (bool) [query]
If there are services in use, then this flag will return a string array containing short descriptions saying what those
services are.
- settings : set (bool) [query]
Returns an array of values with the loaded, autoload, registered flags
- tool : t (unicode) [query]
Returns a string array containing the names of all of the tool contexts registered by this plug-in.
- translator : tr (bool) [query]
Returns a string array containing the names of all of the file translators registered by this plug-in.
- unloadOk : uo (bool) [query]
Returns a boolean that specifies whether or not the plug-in can be safely unloaded. It will return false if the plug-in
is currently in use. For example, if the plug-in adds a new dependency node type, and an instance of that node type is
present in the scene, then this query will return false.
- userNamed : u (bool) [query]
Returns a boolean specifying whether or not the plug-in has been assigned a name by the user.
- vendor : vd (unicode) [query]
Returns a string containing the vendor of the plug-in.
- version : v (bool) [query]
Returns a string containing the version the plug-in.
- writeRequires : wr (bool) [create,query,edit]
Sets whether or not this plug-in should write requirescommand into the saved file. requirescommand could autoload the
plug-in when you open or import that saved file. This way, Maya will load the plug-in when a file is being loaded for
some specified reason, such as to create a customized UI or to load some plug-in data that is not saved in any node or
attributes. For example, stereoCamerais using this flag for its customized UI. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.pluginInfo`
|
mayaSDK/pymel/core/system.py
|
pluginInfo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def pluginInfo(*args, **kwargs):
"\n This command provides access to the plug-in registry of the application. It is used mainly to query the characteristics\n of registered plug-ins. Plugins automatically become registered the first time that they are loaded. The argument is\n either the internal name of the plug-in or the path to access it.\n \n Flags:\n - activeFile : af (bool) [query]\n Restricts the command to the active file only, not the entire scene. This only affects the -dependNode/-dn and\n -pluginsInUse/-pu flags. For use during export selected.\n \n - animCurveInterp : aci (unicode) [query]\n Returns a string array containing the names of all of the animation curve interpolators registered by this plug-in.\n \n - apiVersion : av (bool) [query]\n Returns a string containing the version of the API that this plug-in was compiled with. See the comments in MTypes.h\n for the details on how to interpret this value.\n \n - autoload : a (bool) [create,query,edit]\n Sets whether or not this plug-in should be loaded every time the application starts up. Returns a boolean in query mode.\n \n - cacheFormat : cf (bool) [query]\n Returns a string array containing the names of all of the registered geometry cache formats\n \n - changedCommand : cc (script) [create]\n Adds a callback that will get executed every time the plug-in registry changes. Any other previously registered\n callbacks will also get called.\n \n - command : c (unicode) [query]\n Returns a string array containing the names of all of the normal commands registered by this plug-in. Constraint,\n control, context and model editor commands are not included.\n \n - constraintCommand : cnc (unicode) [query]\n Returns a string array containing the names of all of the constraint commands registered by this plug-in.\n \n - controlCommand : ctc (unicode) [query]\n Returns a string array containing the names of all of the control commands registered by this plug-in.\n \n - data : d (unicode, unicode) [query]\n Returns a string array containing the names of all of the data types registered by this plug-in.\n \n - dependNode : dn (bool) [query]\n Returns a string array containing the names of all of the custom nodes types registered by this plug-in.\n \n - dependNodeByType : dnt (unicode) [query]\n Returns a string array of all registered node types within a specified class of nodes. Each custom node type registered\n by a plug-in belongs to a more general class of node types as specified by its MPxNode::Type. The flag's argument is an\n MPxNode::Type as a string. For example, if you want to list all registered Locator nodes, you should specify\n kLocatorNode as a argument to this flag.\n \n - dependNodeId : dni (unicode) [query]\n Returns an integer array containing the ids of all of the custom node types registered by this plug-in.\n \n - device : dv (bool) [query]\n Returns a string array containing the names of all of the devices registered by this plug-in.\n \n - dragAndDropBehavior : ddb (bool) [query]\n Returns a string array containing the names of all of the drag and drop behaviors registered by this plug-in.\n \n - iksolver : ik (bool) [query]\n Returns a string array containing the names of all of the ik solvers registered by this plug-in.\n \n - listPlugins : ls (bool) [query]\n Returns a string array containing all the plug-ins that are currently loaded.\n \n - listPluginsPath : lsp (bool) [query]\n Returns a string array containing the full paths of all the plug-ins that are currently loaded.\n \n - loadPluginPrefs : lpp (bool) [create]\n Loads the plug-in preferences (ie. autoload) from pluginPrefs.mel into Maya.\n \n - loaded : l (bool) [query]\n Returns a boolean specifying whether or not the plug-in is loaded.\n \n - modelEditorCommand : mec (unicode) [query]\n Returns a string array containing the names of all of the model editor commands registered by this plug-in.\n \n - name : n (unicode) [query]\n Returns a string containing the internal name by which the plug-in is registered.\n \n - path : p (unicode) [query]\n Returns a string containing the absolute path name to the plug-in.\n \n - pluginsInUse : pu (bool) [query]\n Returns a string array containing all the plug-ins that are currently being used in the scene.\n \n - registered : r (bool) [query]\n Returns a boolean specifying whether or not plug-in is currently registered with the system.\n \n - remove : rm (bool) [edit]\n Removes the given plug-in's record from the registry. There is no return value.\n \n - renderer : rdr (bool) [query]\n Returns a string array containing the names of all of the renderers registered by this plug-in.\n \n - savePluginPrefs : spp (bool) [create]\n Saves the plug-in preferences (ie. autoload) out to pluginPrefs.mel\n \n - serviceDescriptions : sd (bool) [query]\n If there are services in use, then this flag will return a string array containing short descriptions saying what those\n services are.\n \n - settings : set (bool) [query]\n Returns an array of values with the loaded, autoload, registered flags\n \n - tool : t (unicode) [query]\n Returns a string array containing the names of all of the tool contexts registered by this plug-in.\n \n - translator : tr (bool) [query]\n Returns a string array containing the names of all of the file translators registered by this plug-in.\n \n - unloadOk : uo (bool) [query]\n Returns a boolean that specifies whether or not the plug-in can be safely unloaded. It will return false if the plug-in\n is currently in use. For example, if the plug-in adds a new dependency node type, and an instance of that node type is\n present in the scene, then this query will return false.\n \n - userNamed : u (bool) [query]\n Returns a boolean specifying whether or not the plug-in has been assigned a name by the user.\n \n - vendor : vd (unicode) [query]\n Returns a string containing the vendor of the plug-in.\n \n - version : v (bool) [query]\n Returns a string containing the version the plug-in.\n \n - writeRequires : wr (bool) [create,query,edit]\n Sets whether or not this plug-in should write requirescommand into the saved file. requirescommand could autoload the\n plug-in when you open or import that saved file. This way, Maya will load the plug-in when a file is being loaded for\n some specified reason, such as to create a customized UI or to load some plug-in data that is not saved in any node or\n attributes. For example, stereoCamerais using this flag for its customized UI. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.pluginInfo`\n "
pass
|
def pluginInfo(*args, **kwargs):
"\n This command provides access to the plug-in registry of the application. It is used mainly to query the characteristics\n of registered plug-ins. Plugins automatically become registered the first time that they are loaded. The argument is\n either the internal name of the plug-in or the path to access it.\n \n Flags:\n - activeFile : af (bool) [query]\n Restricts the command to the active file only, not the entire scene. This only affects the -dependNode/-dn and\n -pluginsInUse/-pu flags. For use during export selected.\n \n - animCurveInterp : aci (unicode) [query]\n Returns a string array containing the names of all of the animation curve interpolators registered by this plug-in.\n \n - apiVersion : av (bool) [query]\n Returns a string containing the version of the API that this plug-in was compiled with. See the comments in MTypes.h\n for the details on how to interpret this value.\n \n - autoload : a (bool) [create,query,edit]\n Sets whether or not this plug-in should be loaded every time the application starts up. Returns a boolean in query mode.\n \n - cacheFormat : cf (bool) [query]\n Returns a string array containing the names of all of the registered geometry cache formats\n \n - changedCommand : cc (script) [create]\n Adds a callback that will get executed every time the plug-in registry changes. Any other previously registered\n callbacks will also get called.\n \n - command : c (unicode) [query]\n Returns a string array containing the names of all of the normal commands registered by this plug-in. Constraint,\n control, context and model editor commands are not included.\n \n - constraintCommand : cnc (unicode) [query]\n Returns a string array containing the names of all of the constraint commands registered by this plug-in.\n \n - controlCommand : ctc (unicode) [query]\n Returns a string array containing the names of all of the control commands registered by this plug-in.\n \n - data : d (unicode, unicode) [query]\n Returns a string array containing the names of all of the data types registered by this plug-in.\n \n - dependNode : dn (bool) [query]\n Returns a string array containing the names of all of the custom nodes types registered by this plug-in.\n \n - dependNodeByType : dnt (unicode) [query]\n Returns a string array of all registered node types within a specified class of nodes. Each custom node type registered\n by a plug-in belongs to a more general class of node types as specified by its MPxNode::Type. The flag's argument is an\n MPxNode::Type as a string. For example, if you want to list all registered Locator nodes, you should specify\n kLocatorNode as a argument to this flag.\n \n - dependNodeId : dni (unicode) [query]\n Returns an integer array containing the ids of all of the custom node types registered by this plug-in.\n \n - device : dv (bool) [query]\n Returns a string array containing the names of all of the devices registered by this plug-in.\n \n - dragAndDropBehavior : ddb (bool) [query]\n Returns a string array containing the names of all of the drag and drop behaviors registered by this plug-in.\n \n - iksolver : ik (bool) [query]\n Returns a string array containing the names of all of the ik solvers registered by this plug-in.\n \n - listPlugins : ls (bool) [query]\n Returns a string array containing all the plug-ins that are currently loaded.\n \n - listPluginsPath : lsp (bool) [query]\n Returns a string array containing the full paths of all the plug-ins that are currently loaded.\n \n - loadPluginPrefs : lpp (bool) [create]\n Loads the plug-in preferences (ie. autoload) from pluginPrefs.mel into Maya.\n \n - loaded : l (bool) [query]\n Returns a boolean specifying whether or not the plug-in is loaded.\n \n - modelEditorCommand : mec (unicode) [query]\n Returns a string array containing the names of all of the model editor commands registered by this plug-in.\n \n - name : n (unicode) [query]\n Returns a string containing the internal name by which the plug-in is registered.\n \n - path : p (unicode) [query]\n Returns a string containing the absolute path name to the plug-in.\n \n - pluginsInUse : pu (bool) [query]\n Returns a string array containing all the plug-ins that are currently being used in the scene.\n \n - registered : r (bool) [query]\n Returns a boolean specifying whether or not plug-in is currently registered with the system.\n \n - remove : rm (bool) [edit]\n Removes the given plug-in's record from the registry. There is no return value.\n \n - renderer : rdr (bool) [query]\n Returns a string array containing the names of all of the renderers registered by this plug-in.\n \n - savePluginPrefs : spp (bool) [create]\n Saves the plug-in preferences (ie. autoload) out to pluginPrefs.mel\n \n - serviceDescriptions : sd (bool) [query]\n If there are services in use, then this flag will return a string array containing short descriptions saying what those\n services are.\n \n - settings : set (bool) [query]\n Returns an array of values with the loaded, autoload, registered flags\n \n - tool : t (unicode) [query]\n Returns a string array containing the names of all of the tool contexts registered by this plug-in.\n \n - translator : tr (bool) [query]\n Returns a string array containing the names of all of the file translators registered by this plug-in.\n \n - unloadOk : uo (bool) [query]\n Returns a boolean that specifies whether or not the plug-in can be safely unloaded. It will return false if the plug-in\n is currently in use. For example, if the plug-in adds a new dependency node type, and an instance of that node type is\n present in the scene, then this query will return false.\n \n - userNamed : u (bool) [query]\n Returns a boolean specifying whether or not the plug-in has been assigned a name by the user.\n \n - vendor : vd (unicode) [query]\n Returns a string containing the vendor of the plug-in.\n \n - version : v (bool) [query]\n Returns a string containing the version the plug-in.\n \n - writeRequires : wr (bool) [create,query,edit]\n Sets whether or not this plug-in should write requirescommand into the saved file. requirescommand could autoload the\n plug-in when you open or import that saved file. This way, Maya will load the plug-in when a file is being loaded for\n some specified reason, such as to create a customized UI or to load some plug-in data that is not saved in any node or\n attributes. For example, stereoCamerais using this flag for its customized UI. Flag can have multiple\n arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.pluginInfo`\n "
pass<|docstring|>This command provides access to the plug-in registry of the application. It is used mainly to query the characteristics
of registered plug-ins. Plugins automatically become registered the first time that they are loaded. The argument is
either the internal name of the plug-in or the path to access it.
Flags:
- activeFile : af (bool) [query]
Restricts the command to the active file only, not the entire scene. This only affects the -dependNode/-dn and
-pluginsInUse/-pu flags. For use during export selected.
- animCurveInterp : aci (unicode) [query]
Returns a string array containing the names of all of the animation curve interpolators registered by this plug-in.
- apiVersion : av (bool) [query]
Returns a string containing the version of the API that this plug-in was compiled with. See the comments in MTypes.h
for the details on how to interpret this value.
- autoload : a (bool) [create,query,edit]
Sets whether or not this plug-in should be loaded every time the application starts up. Returns a boolean in query mode.
- cacheFormat : cf (bool) [query]
Returns a string array containing the names of all of the registered geometry cache formats
- changedCommand : cc (script) [create]
Adds a callback that will get executed every time the plug-in registry changes. Any other previously registered
callbacks will also get called.
- command : c (unicode) [query]
Returns a string array containing the names of all of the normal commands registered by this plug-in. Constraint,
control, context and model editor commands are not included.
- constraintCommand : cnc (unicode) [query]
Returns a string array containing the names of all of the constraint commands registered by this plug-in.
- controlCommand : ctc (unicode) [query]
Returns a string array containing the names of all of the control commands registered by this plug-in.
- data : d (unicode, unicode) [query]
Returns a string array containing the names of all of the data types registered by this plug-in.
- dependNode : dn (bool) [query]
Returns a string array containing the names of all of the custom nodes types registered by this plug-in.
- dependNodeByType : dnt (unicode) [query]
Returns a string array of all registered node types within a specified class of nodes. Each custom node type registered
by a plug-in belongs to a more general class of node types as specified by its MPxNode::Type. The flag's argument is an
MPxNode::Type as a string. For example, if you want to list all registered Locator nodes, you should specify
kLocatorNode as a argument to this flag.
- dependNodeId : dni (unicode) [query]
Returns an integer array containing the ids of all of the custom node types registered by this plug-in.
- device : dv (bool) [query]
Returns a string array containing the names of all of the devices registered by this plug-in.
- dragAndDropBehavior : ddb (bool) [query]
Returns a string array containing the names of all of the drag and drop behaviors registered by this plug-in.
- iksolver : ik (bool) [query]
Returns a string array containing the names of all of the ik solvers registered by this plug-in.
- listPlugins : ls (bool) [query]
Returns a string array containing all the plug-ins that are currently loaded.
- listPluginsPath : lsp (bool) [query]
Returns a string array containing the full paths of all the plug-ins that are currently loaded.
- loadPluginPrefs : lpp (bool) [create]
Loads the plug-in preferences (ie. autoload) from pluginPrefs.mel into Maya.
- loaded : l (bool) [query]
Returns a boolean specifying whether or not the plug-in is loaded.
- modelEditorCommand : mec (unicode) [query]
Returns a string array containing the names of all of the model editor commands registered by this plug-in.
- name : n (unicode) [query]
Returns a string containing the internal name by which the plug-in is registered.
- path : p (unicode) [query]
Returns a string containing the absolute path name to the plug-in.
- pluginsInUse : pu (bool) [query]
Returns a string array containing all the plug-ins that are currently being used in the scene.
- registered : r (bool) [query]
Returns a boolean specifying whether or not plug-in is currently registered with the system.
- remove : rm (bool) [edit]
Removes the given plug-in's record from the registry. There is no return value.
- renderer : rdr (bool) [query]
Returns a string array containing the names of all of the renderers registered by this plug-in.
- savePluginPrefs : spp (bool) [create]
Saves the plug-in preferences (ie. autoload) out to pluginPrefs.mel
- serviceDescriptions : sd (bool) [query]
If there are services in use, then this flag will return a string array containing short descriptions saying what those
services are.
- settings : set (bool) [query]
Returns an array of values with the loaded, autoload, registered flags
- tool : t (unicode) [query]
Returns a string array containing the names of all of the tool contexts registered by this plug-in.
- translator : tr (bool) [query]
Returns a string array containing the names of all of the file translators registered by this plug-in.
- unloadOk : uo (bool) [query]
Returns a boolean that specifies whether or not the plug-in can be safely unloaded. It will return false if the plug-in
is currently in use. For example, if the plug-in adds a new dependency node type, and an instance of that node type is
present in the scene, then this query will return false.
- userNamed : u (bool) [query]
Returns a boolean specifying whether or not the plug-in has been assigned a name by the user.
- vendor : vd (unicode) [query]
Returns a string containing the vendor of the plug-in.
- version : v (bool) [query]
Returns a string containing the version the plug-in.
- writeRequires : wr (bool) [create,query,edit]
Sets whether or not this plug-in should write requirescommand into the saved file. requirescommand could autoload the
plug-in when you open or import that saved file. This way, Maya will load the plug-in when a file is being loaded for
some specified reason, such as to create a customized UI or to load some plug-in data that is not saved in any node or
attributes. For example, stereoCamerais using this flag for its customized UI. Flag can have multiple
arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.pluginInfo`<|endoftext|>
|
2795873c4bd40677b3ebf4883f36d2a01b367af9b4a01f3fb7402b58abf905f6
|
def undoInfo(*args, **kwargs):
'\n This command controls the undo/redo parameters. In query mode, if invoked without flags (other than the query flag),\n this command will return the number of items currently on the undo queue.\n \n Flags:\n - chunkName : cn (unicode) [create,query]\n Sets the name used to identify a chunk for undo/redo purposes when opening a chunk.\n \n - closeChunk : cck (bool) [create]\n Closes the chunk that was opened earlier by openChunk. Once close chunk is called, all undoable operations in the chunk\n will undo as a single undo operation. Use with CAUTION!! Improper use of this command can leave the undo queue in a bad\n state.\n \n - infinity : infinity (bool) [create,query]\n Set the queue length to infinity.\n \n - length : l (int) [create,query]\n Specifies the maximum number of items in the undo queue. The infinity flag overrides this one.\n \n - openChunk : ock (bool) [create]\n Opens a chunk so that all undoable operations after this call will fall into the newly opened chunk, until close chunk\n is called. Once close chunk is called, all undoable operations in the chunk will undo as a single undo operation. Use\n with CAUTION!! Improper use of this command can leave the undo queue in a bad state.\n \n - printQueue : pq (bool) [query]\n Prints to the Script Editor the contents of the undo queue.\n \n - redoName : rn (unicode) [query]\n Returns what will be redone (if anything)\n \n - redoQueueEmpty : rqe (bool) [query]\n Return true if the redo queue is empty. Return false if there is at least one command in the queue to be redone.\n \n - state : st (bool) [create,query]\n Turns undo/redo on or off.\n \n - stateWithoutFlush : swf (bool) [create,query]\n Turns undo/redo on or off without flushing the queue. Use with CAUTION!! Note that if you perform destructive\n operations while stateWithoutFlush is disabled, and you then enable it again, subsequent undo operations that try to go\n past the destructive operations may be unstable since undo will not be able to properly reconstruct the former state of\n the scene.\n \n - undoName : un (unicode) [query]\n Returns what will be undone (if anything)\n \n - undoQueueEmpty : uqe (bool) [query]\n Return true if the undo queue is empty. Return false if there is at least one command in the queue to be undone.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.undoInfo`\n '
pass
|
This command controls the undo/redo parameters. In query mode, if invoked without flags (other than the query flag),
this command will return the number of items currently on the undo queue.
Flags:
- chunkName : cn (unicode) [create,query]
Sets the name used to identify a chunk for undo/redo purposes when opening a chunk.
- closeChunk : cck (bool) [create]
Closes the chunk that was opened earlier by openChunk. Once close chunk is called, all undoable operations in the chunk
will undo as a single undo operation. Use with CAUTION!! Improper use of this command can leave the undo queue in a bad
state.
- infinity : infinity (bool) [create,query]
Set the queue length to infinity.
- length : l (int) [create,query]
Specifies the maximum number of items in the undo queue. The infinity flag overrides this one.
- openChunk : ock (bool) [create]
Opens a chunk so that all undoable operations after this call will fall into the newly opened chunk, until close chunk
is called. Once close chunk is called, all undoable operations in the chunk will undo as a single undo operation. Use
with CAUTION!! Improper use of this command can leave the undo queue in a bad state.
- printQueue : pq (bool) [query]
Prints to the Script Editor the contents of the undo queue.
- redoName : rn (unicode) [query]
Returns what will be redone (if anything)
- redoQueueEmpty : rqe (bool) [query]
Return true if the redo queue is empty. Return false if there is at least one command in the queue to be redone.
- state : st (bool) [create,query]
Turns undo/redo on or off.
- stateWithoutFlush : swf (bool) [create,query]
Turns undo/redo on or off without flushing the queue. Use with CAUTION!! Note that if you perform destructive
operations while stateWithoutFlush is disabled, and you then enable it again, subsequent undo operations that try to go
past the destructive operations may be unstable since undo will not be able to properly reconstruct the former state of
the scene.
- undoName : un (unicode) [query]
Returns what will be undone (if anything)
- undoQueueEmpty : uqe (bool) [query]
Return true if the undo queue is empty. Return false if there is at least one command in the queue to be undone.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.undoInfo`
|
mayaSDK/pymel/core/system.py
|
undoInfo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def undoInfo(*args, **kwargs):
'\n This command controls the undo/redo parameters. In query mode, if invoked without flags (other than the query flag),\n this command will return the number of items currently on the undo queue.\n \n Flags:\n - chunkName : cn (unicode) [create,query]\n Sets the name used to identify a chunk for undo/redo purposes when opening a chunk.\n \n - closeChunk : cck (bool) [create]\n Closes the chunk that was opened earlier by openChunk. Once close chunk is called, all undoable operations in the chunk\n will undo as a single undo operation. Use with CAUTION!! Improper use of this command can leave the undo queue in a bad\n state.\n \n - infinity : infinity (bool) [create,query]\n Set the queue length to infinity.\n \n - length : l (int) [create,query]\n Specifies the maximum number of items in the undo queue. The infinity flag overrides this one.\n \n - openChunk : ock (bool) [create]\n Opens a chunk so that all undoable operations after this call will fall into the newly opened chunk, until close chunk\n is called. Once close chunk is called, all undoable operations in the chunk will undo as a single undo operation. Use\n with CAUTION!! Improper use of this command can leave the undo queue in a bad state.\n \n - printQueue : pq (bool) [query]\n Prints to the Script Editor the contents of the undo queue.\n \n - redoName : rn (unicode) [query]\n Returns what will be redone (if anything)\n \n - redoQueueEmpty : rqe (bool) [query]\n Return true if the redo queue is empty. Return false if there is at least one command in the queue to be redone.\n \n - state : st (bool) [create,query]\n Turns undo/redo on or off.\n \n - stateWithoutFlush : swf (bool) [create,query]\n Turns undo/redo on or off without flushing the queue. Use with CAUTION!! Note that if you perform destructive\n operations while stateWithoutFlush is disabled, and you then enable it again, subsequent undo operations that try to go\n past the destructive operations may be unstable since undo will not be able to properly reconstruct the former state of\n the scene.\n \n - undoName : un (unicode) [query]\n Returns what will be undone (if anything)\n \n - undoQueueEmpty : uqe (bool) [query]\n Return true if the undo queue is empty. Return false if there is at least one command in the queue to be undone.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.undoInfo`\n '
pass
|
def undoInfo(*args, **kwargs):
'\n This command controls the undo/redo parameters. In query mode, if invoked without flags (other than the query flag),\n this command will return the number of items currently on the undo queue.\n \n Flags:\n - chunkName : cn (unicode) [create,query]\n Sets the name used to identify a chunk for undo/redo purposes when opening a chunk.\n \n - closeChunk : cck (bool) [create]\n Closes the chunk that was opened earlier by openChunk. Once close chunk is called, all undoable operations in the chunk\n will undo as a single undo operation. Use with CAUTION!! Improper use of this command can leave the undo queue in a bad\n state.\n \n - infinity : infinity (bool) [create,query]\n Set the queue length to infinity.\n \n - length : l (int) [create,query]\n Specifies the maximum number of items in the undo queue. The infinity flag overrides this one.\n \n - openChunk : ock (bool) [create]\n Opens a chunk so that all undoable operations after this call will fall into the newly opened chunk, until close chunk\n is called. Once close chunk is called, all undoable operations in the chunk will undo as a single undo operation. Use\n with CAUTION!! Improper use of this command can leave the undo queue in a bad state.\n \n - printQueue : pq (bool) [query]\n Prints to the Script Editor the contents of the undo queue.\n \n - redoName : rn (unicode) [query]\n Returns what will be redone (if anything)\n \n - redoQueueEmpty : rqe (bool) [query]\n Return true if the redo queue is empty. Return false if there is at least one command in the queue to be redone.\n \n - state : st (bool) [create,query]\n Turns undo/redo on or off.\n \n - stateWithoutFlush : swf (bool) [create,query]\n Turns undo/redo on or off without flushing the queue. Use with CAUTION!! Note that if you perform destructive\n operations while stateWithoutFlush is disabled, and you then enable it again, subsequent undo operations that try to go\n past the destructive operations may be unstable since undo will not be able to properly reconstruct the former state of\n the scene.\n \n - undoName : un (unicode) [query]\n Returns what will be undone (if anything)\n \n - undoQueueEmpty : uqe (bool) [query]\n Return true if the undo queue is empty. Return false if there is at least one command in the queue to be undone.\n Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.undoInfo`\n '
pass<|docstring|>This command controls the undo/redo parameters. In query mode, if invoked without flags (other than the query flag),
this command will return the number of items currently on the undo queue.
Flags:
- chunkName : cn (unicode) [create,query]
Sets the name used to identify a chunk for undo/redo purposes when opening a chunk.
- closeChunk : cck (bool) [create]
Closes the chunk that was opened earlier by openChunk. Once close chunk is called, all undoable operations in the chunk
will undo as a single undo operation. Use with CAUTION!! Improper use of this command can leave the undo queue in a bad
state.
- infinity : infinity (bool) [create,query]
Set the queue length to infinity.
- length : l (int) [create,query]
Specifies the maximum number of items in the undo queue. The infinity flag overrides this one.
- openChunk : ock (bool) [create]
Opens a chunk so that all undoable operations after this call will fall into the newly opened chunk, until close chunk
is called. Once close chunk is called, all undoable operations in the chunk will undo as a single undo operation. Use
with CAUTION!! Improper use of this command can leave the undo queue in a bad state.
- printQueue : pq (bool) [query]
Prints to the Script Editor the contents of the undo queue.
- redoName : rn (unicode) [query]
Returns what will be redone (if anything)
- redoQueueEmpty : rqe (bool) [query]
Return true if the redo queue is empty. Return false if there is at least one command in the queue to be redone.
- state : st (bool) [create,query]
Turns undo/redo on or off.
- stateWithoutFlush : swf (bool) [create,query]
Turns undo/redo on or off without flushing the queue. Use with CAUTION!! Note that if you perform destructive
operations while stateWithoutFlush is disabled, and you then enable it again, subsequent undo operations that try to go
past the destructive operations may be unstable since undo will not be able to properly reconstruct the former state of
the scene.
- undoName : un (unicode) [query]
Returns what will be undone (if anything)
- undoQueueEmpty : uqe (bool) [query]
Return true if the undo queue is empty. Return false if there is at least one command in the queue to be undone.
Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.undoInfo`<|endoftext|>
|
c4c46d1247e24fbd6997f2a9a4cd44ca1e5e6e89dc4408e666df6bc8fdde1a1b
|
def setInputDeviceMapping(*args, **kwargs):
"\n The command sets a scale and offset for all attachments made to a specified device axis. Any attachment made to a mapped\n device axis will have the scale and offset applied to its values. The value from the device is multiplied by the scale\n and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting value. If\n the mapping is relative, the final value is the offset added to the scaled difference between the current device value\n and the previous device value. This mapping will be applied to the device data before any mappings defined by the\n setAttrMapping command. A typical use would be to scale a device's input so that it is within a usable range. For\n example, the device mapping can be used to calibrate a spaceball to work in a specific section of a scene. As an\n example, if the space ball is setup with absolute device mappings, constantly pressing in one direction will cause the\n attached attribute to get a constant value. If a relative mapping is used, and the spaceball is pressed in one\n direction, the attached attribute will jump a constantly increasing (or constantly decreasing) value and will find a\n rest value equal to the offset. There are important differences between how the relative flag is handled by this command\n and the setAttrMapping command. (See the setAttrMapping documentation for specifics on how it calculates relative\n values). In general, both a relative device mapping (this command) and a relative attachment mapping (setAttrMapping)\n should not be used together on the same axis.\n \n Dynamic library stub function\n \n Flags:\n - absolute : a (bool) [create]\n report absolute axis values\n \n - axis : ax (unicode) [create]\n specify the axis to map\n \n - device : d (unicode) [create]\n specify which device to map\n \n - offset : o (float) [create]\n specify the axis offset value\n \n - relative : r (bool) [create]\n report the change in axis value since the last sample\n \n - scale : s (float) [create]\n specify the axis scale value\n \n - view : v (bool) [create]\n translate the device coordinates into the coordinates of the active camera\n \n - world : w (bool) [create]\n translate the device coordinates into world space coordinates Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.setInputDeviceMapping`\n "
pass
|
The command sets a scale and offset for all attachments made to a specified device axis. Any attachment made to a mapped
device axis will have the scale and offset applied to its values. The value from the device is multiplied by the scale
and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting value. If
the mapping is relative, the final value is the offset added to the scaled difference between the current device value
and the previous device value. This mapping will be applied to the device data before any mappings defined by the
setAttrMapping command. A typical use would be to scale a device's input so that it is within a usable range. For
example, the device mapping can be used to calibrate a spaceball to work in a specific section of a scene. As an
example, if the space ball is setup with absolute device mappings, constantly pressing in one direction will cause the
attached attribute to get a constant value. If a relative mapping is used, and the spaceball is pressed in one
direction, the attached attribute will jump a constantly increasing (or constantly decreasing) value and will find a
rest value equal to the offset. There are important differences between how the relative flag is handled by this command
and the setAttrMapping command. (See the setAttrMapping documentation for specifics on how it calculates relative
values). In general, both a relative device mapping (this command) and a relative attachment mapping (setAttrMapping)
should not be used together on the same axis.
Dynamic library stub function
Flags:
- absolute : a (bool) [create]
report absolute axis values
- axis : ax (unicode) [create]
specify the axis to map
- device : d (unicode) [create]
specify which device to map
- offset : o (float) [create]
specify the axis offset value
- relative : r (bool) [create]
report the change in axis value since the last sample
- scale : s (float) [create]
specify the axis scale value
- view : v (bool) [create]
translate the device coordinates into the coordinates of the active camera
- world : w (bool) [create]
translate the device coordinates into world space coordinates Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.setInputDeviceMapping`
|
mayaSDK/pymel/core/system.py
|
setInputDeviceMapping
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def setInputDeviceMapping(*args, **kwargs):
"\n The command sets a scale and offset for all attachments made to a specified device axis. Any attachment made to a mapped\n device axis will have the scale and offset applied to its values. The value from the device is multiplied by the scale\n and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting value. If\n the mapping is relative, the final value is the offset added to the scaled difference between the current device value\n and the previous device value. This mapping will be applied to the device data before any mappings defined by the\n setAttrMapping command. A typical use would be to scale a device's input so that it is within a usable range. For\n example, the device mapping can be used to calibrate a spaceball to work in a specific section of a scene. As an\n example, if the space ball is setup with absolute device mappings, constantly pressing in one direction will cause the\n attached attribute to get a constant value. If a relative mapping is used, and the spaceball is pressed in one\n direction, the attached attribute will jump a constantly increasing (or constantly decreasing) value and will find a\n rest value equal to the offset. There are important differences between how the relative flag is handled by this command\n and the setAttrMapping command. (See the setAttrMapping documentation for specifics on how it calculates relative\n values). In general, both a relative device mapping (this command) and a relative attachment mapping (setAttrMapping)\n should not be used together on the same axis.\n \n Dynamic library stub function\n \n Flags:\n - absolute : a (bool) [create]\n report absolute axis values\n \n - axis : ax (unicode) [create]\n specify the axis to map\n \n - device : d (unicode) [create]\n specify which device to map\n \n - offset : o (float) [create]\n specify the axis offset value\n \n - relative : r (bool) [create]\n report the change in axis value since the last sample\n \n - scale : s (float) [create]\n specify the axis scale value\n \n - view : v (bool) [create]\n translate the device coordinates into the coordinates of the active camera\n \n - world : w (bool) [create]\n translate the device coordinates into world space coordinates Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.setInputDeviceMapping`\n "
pass
|
def setInputDeviceMapping(*args, **kwargs):
"\n The command sets a scale and offset for all attachments made to a specified device axis. Any attachment made to a mapped\n device axis will have the scale and offset applied to its values. The value from the device is multiplied by the scale\n and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting value. If\n the mapping is relative, the final value is the offset added to the scaled difference between the current device value\n and the previous device value. This mapping will be applied to the device data before any mappings defined by the\n setAttrMapping command. A typical use would be to scale a device's input so that it is within a usable range. For\n example, the device mapping can be used to calibrate a spaceball to work in a specific section of a scene. As an\n example, if the space ball is setup with absolute device mappings, constantly pressing in one direction will cause the\n attached attribute to get a constant value. If a relative mapping is used, and the spaceball is pressed in one\n direction, the attached attribute will jump a constantly increasing (or constantly decreasing) value and will find a\n rest value equal to the offset. There are important differences between how the relative flag is handled by this command\n and the setAttrMapping command. (See the setAttrMapping documentation for specifics on how it calculates relative\n values). In general, both a relative device mapping (this command) and a relative attachment mapping (setAttrMapping)\n should not be used together on the same axis.\n \n Dynamic library stub function\n \n Flags:\n - absolute : a (bool) [create]\n report absolute axis values\n \n - axis : ax (unicode) [create]\n specify the axis to map\n \n - device : d (unicode) [create]\n specify which device to map\n \n - offset : o (float) [create]\n specify the axis offset value\n \n - relative : r (bool) [create]\n report the change in axis value since the last sample\n \n - scale : s (float) [create]\n specify the axis scale value\n \n - view : v (bool) [create]\n translate the device coordinates into the coordinates of the active camera\n \n - world : w (bool) [create]\n translate the device coordinates into world space coordinates Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.setInputDeviceMapping`\n "
pass<|docstring|>The command sets a scale and offset for all attachments made to a specified device axis. Any attachment made to a mapped
device axis will have the scale and offset applied to its values. The value from the device is multiplied by the scale
and the offset is added to this product. With an absolute mapping, the attached attribute gets the resulting value. If
the mapping is relative, the final value is the offset added to the scaled difference between the current device value
and the previous device value. This mapping will be applied to the device data before any mappings defined by the
setAttrMapping command. A typical use would be to scale a device's input so that it is within a usable range. For
example, the device mapping can be used to calibrate a spaceball to work in a specific section of a scene. As an
example, if the space ball is setup with absolute device mappings, constantly pressing in one direction will cause the
attached attribute to get a constant value. If a relative mapping is used, and the spaceball is pressed in one
direction, the attached attribute will jump a constantly increasing (or constantly decreasing) value and will find a
rest value equal to the offset. There are important differences between how the relative flag is handled by this command
and the setAttrMapping command. (See the setAttrMapping documentation for specifics on how it calculates relative
values). In general, both a relative device mapping (this command) and a relative attachment mapping (setAttrMapping)
should not be used together on the same axis.
Dynamic library stub function
Flags:
- absolute : a (bool) [create]
report absolute axis values
- axis : ax (unicode) [create]
specify the axis to map
- device : d (unicode) [create]
specify which device to map
- offset : o (float) [create]
specify the axis offset value
- relative : r (bool) [create]
report the change in axis value since the last sample
- scale : s (float) [create]
specify the axis scale value
- view : v (bool) [create]
translate the device coordinates into the coordinates of the active camera
- world : w (bool) [create]
translate the device coordinates into world space coordinates Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.setInputDeviceMapping`<|endoftext|>
|
54442610cb75938115870f06a5ec9a13023fc39abf8361bfa7ef9a35bb07229d
|
def iterReferences(parentReference='None', recursive='False', namespaces='False', refNodes='False', references='True', recurseType="'depth'", loaded='None', unloaded='None'):
"\n returns references in the scene as a list of value tuples.\n \n The values in the tuples can be namespaces, refNodes (as PyNodes), and/or\n references (as FileReferences), and are controlled by their respective\n keywords (and are returned in that order). If only one of the three options\n is True, the result will not be a list of value tuples, but will simply be a\n list of values.\n \n Parameters\n ----------\n parentReference : string, `Path`, or `FileReference`\n a reference to get sub-references from. If None (default), the current\n scene is used.\n \n recursive : bool\n recursively determine all references and sub-references\n \n namespaces : bool\n controls whether namespaces are returned\n \n refNodes : bool\n controls whether reference PyNodes are returned\n \n refNodes : bool\n controls whether FileReferences returned\n \n recurseType : string\n if recursing, whether to do a 'breadth' or 'depth' first search;\n defaults to a 'depth' first\n \n loaded : bool or None\n whether to return loaded references in the return result; if both of\n loaded/unloaded are not given (or None), then both are assumed True;\n if only one is given, the other is assumed to have the opposite boolean\n value\n \n unloaded : bool or None\n whether to return unloaded references in the return result; if both of\n loaded/unloaded are not given (or None), then both are assumed True;\n if only one is given, the other is assumed to have the opposite boolean\n value\n "
pass
|
returns references in the scene as a list of value tuples.
The values in the tuples can be namespaces, refNodes (as PyNodes), and/or
references (as FileReferences), and are controlled by their respective
keywords (and are returned in that order). If only one of the three options
is True, the result will not be a list of value tuples, but will simply be a
list of values.
Parameters
----------
parentReference : string, `Path`, or `FileReference`
a reference to get sub-references from. If None (default), the current
scene is used.
recursive : bool
recursively determine all references and sub-references
namespaces : bool
controls whether namespaces are returned
refNodes : bool
controls whether reference PyNodes are returned
refNodes : bool
controls whether FileReferences returned
recurseType : string
if recursing, whether to do a 'breadth' or 'depth' first search;
defaults to a 'depth' first
loaded : bool or None
whether to return loaded references in the return result; if both of
loaded/unloaded are not given (or None), then both are assumed True;
if only one is given, the other is assumed to have the opposite boolean
value
unloaded : bool or None
whether to return unloaded references in the return result; if both of
loaded/unloaded are not given (or None), then both are assumed True;
if only one is given, the other is assumed to have the opposite boolean
value
|
mayaSDK/pymel/core/system.py
|
iterReferences
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def iterReferences(parentReference='None', recursive='False', namespaces='False', refNodes='False', references='True', recurseType="'depth'", loaded='None', unloaded='None'):
"\n returns references in the scene as a list of value tuples.\n \n The values in the tuples can be namespaces, refNodes (as PyNodes), and/or\n references (as FileReferences), and are controlled by their respective\n keywords (and are returned in that order). If only one of the three options\n is True, the result will not be a list of value tuples, but will simply be a\n list of values.\n \n Parameters\n ----------\n parentReference : string, `Path`, or `FileReference`\n a reference to get sub-references from. If None (default), the current\n scene is used.\n \n recursive : bool\n recursively determine all references and sub-references\n \n namespaces : bool\n controls whether namespaces are returned\n \n refNodes : bool\n controls whether reference PyNodes are returned\n \n refNodes : bool\n controls whether FileReferences returned\n \n recurseType : string\n if recursing, whether to do a 'breadth' or 'depth' first search;\n defaults to a 'depth' first\n \n loaded : bool or None\n whether to return loaded references in the return result; if both of\n loaded/unloaded are not given (or None), then both are assumed True;\n if only one is given, the other is assumed to have the opposite boolean\n value\n \n unloaded : bool or None\n whether to return unloaded references in the return result; if both of\n loaded/unloaded are not given (or None), then both are assumed True;\n if only one is given, the other is assumed to have the opposite boolean\n value\n "
pass
|
def iterReferences(parentReference='None', recursive='False', namespaces='False', refNodes='False', references='True', recurseType="'depth'", loaded='None', unloaded='None'):
"\n returns references in the scene as a list of value tuples.\n \n The values in the tuples can be namespaces, refNodes (as PyNodes), and/or\n references (as FileReferences), and are controlled by their respective\n keywords (and are returned in that order). If only one of the three options\n is True, the result will not be a list of value tuples, but will simply be a\n list of values.\n \n Parameters\n ----------\n parentReference : string, `Path`, or `FileReference`\n a reference to get sub-references from. If None (default), the current\n scene is used.\n \n recursive : bool\n recursively determine all references and sub-references\n \n namespaces : bool\n controls whether namespaces are returned\n \n refNodes : bool\n controls whether reference PyNodes are returned\n \n refNodes : bool\n controls whether FileReferences returned\n \n recurseType : string\n if recursing, whether to do a 'breadth' or 'depth' first search;\n defaults to a 'depth' first\n \n loaded : bool or None\n whether to return loaded references in the return result; if both of\n loaded/unloaded are not given (or None), then both are assumed True;\n if only one is given, the other is assumed to have the opposite boolean\n value\n \n unloaded : bool or None\n whether to return unloaded references in the return result; if both of\n loaded/unloaded are not given (or None), then both are assumed True;\n if only one is given, the other is assumed to have the opposite boolean\n value\n "
pass<|docstring|>returns references in the scene as a list of value tuples.
The values in the tuples can be namespaces, refNodes (as PyNodes), and/or
references (as FileReferences), and are controlled by their respective
keywords (and are returned in that order). If only one of the three options
is True, the result will not be a list of value tuples, but will simply be a
list of values.
Parameters
----------
parentReference : string, `Path`, or `FileReference`
a reference to get sub-references from. If None (default), the current
scene is used.
recursive : bool
recursively determine all references and sub-references
namespaces : bool
controls whether namespaces are returned
refNodes : bool
controls whether reference PyNodes are returned
refNodes : bool
controls whether FileReferences returned
recurseType : string
if recursing, whether to do a 'breadth' or 'depth' first search;
defaults to a 'depth' first
loaded : bool or None
whether to return loaded references in the return result; if both of
loaded/unloaded are not given (or None), then both are assumed True;
if only one is given, the other is assumed to have the opposite boolean
value
unloaded : bool or None
whether to return unloaded references in the return result; if both of
loaded/unloaded are not given (or None), then both are assumed True;
if only one is given, the other is assumed to have the opposite boolean
value<|endoftext|>
|
4cb8a3f2c358b1a2077e770e31acc8baf1872dcbc30f54cd91efef2a14aa43ed
|
def importFile(filepath, **kwargs):
'\n Import the specified file. Returns the name of the imported file. \n \n Flags:\n - loadNoReferences:\n This flag is obsolete and has been replaced witht the loadReferenceDepth flag. When used with the -open flag, no\n references will be loaded. When used with -i/import, -r/reference or -lr/loadReference flags, will load the top-most\n reference only.\n - loadReferenceDepth:\n Used to specify which references should be loaded. Valid types are all, noneand topOnly, which will load all references,\n no references and top-level references only, respectively. May only be used with the -o/open, -i/import, -r/reference or\n -lr/loadReference flags. When noneis used with -lr/loadReference, only path validation is performed. This can be used to\n replace a reference without triggering reload. Not using loadReferenceDepth will load references in the same loaded or\n unloaded state that they were in when the file was saved. Additionally, the -lr/loadReference flag supports a fourth\n type, asPrefs. This will force any nested references to be loaded according to the state (if any) stored in the current\n scene file, rather than according to the state saved in the reference file itself.\n - defaultNamespace:\n Use the default name space for import and referencing. This is an advanced option. If set, then on import or\n reference, Maya will attempt to place all nodes from the imported or referenced file directly into the root (default)\n name space, without invoking any name clash resolution algorithms. If the names of any of the new objects already\n exist in the root namespace, then errors will result. The user of this flag is responsible for creating a name clash\n resolution mechanism outside of Maya to avoid such errors. Note:This flag is intended only for use with custom file\n translators written through the API. Use at your own risk.\n - deferReference:\n When used in conjunction with the -reference flag, this flag determines if the reference is loaded, or if loading is\n deferred.C: The default is false.Q: When queried, this flag returns true if the reference is deferred, or false if the\n reference is not deferred. If this is used with -rfn/referenceNode, the -rfn flag must come before -q.\n - groupReference:\n Used only with the -r or the -i flag. Used to group all the imported/referenced items under a single transform.\n - groupName:\n Used only with the -gr flag. Optionally used to set the name of the transform node that the imported/referenced items\n will be grouped under.\n - renameAll:\n If true, rename all newly-created nodes, not just those whose names clash with existing nodes. Only available with\n -i/import.\n - renamingPrefix:\n The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.\n - swapNamespace:\n Can only be used in conjunction with the -r/reference or -i/import flags. This flag will replace any occurrences of a\n given namespace to an alternate specified namespace. This namespace swapwill occur as the file is referenced in. It\n takes in two string arguments. The first argument specifies the namespace to replace. The second argument specifies the\n replacement namespace. Use of this flag, implicitly enables the use of namespaces and cannot be used with\n deferReference.\n - returnNewNodes:\n Used to control the return value in open, import, loadReference, and reference operations. It will force the file\n command to return a list of new nodes added to the current scene.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Import the specified file. Returns the name of the imported file.
Flags:
- loadNoReferences:
This flag is obsolete and has been replaced witht the loadReferenceDepth flag. When used with the -open flag, no
references will be loaded. When used with -i/import, -r/reference or -lr/loadReference flags, will load the top-most
reference only.
- loadReferenceDepth:
Used to specify which references should be loaded. Valid types are all, noneand topOnly, which will load all references,
no references and top-level references only, respectively. May only be used with the -o/open, -i/import, -r/reference or
-lr/loadReference flags. When noneis used with -lr/loadReference, only path validation is performed. This can be used to
replace a reference without triggering reload. Not using loadReferenceDepth will load references in the same loaded or
unloaded state that they were in when the file was saved. Additionally, the -lr/loadReference flag supports a fourth
type, asPrefs. This will force any nested references to be loaded according to the state (if any) stored in the current
scene file, rather than according to the state saved in the reference file itself.
- defaultNamespace:
Use the default name space for import and referencing. This is an advanced option. If set, then on import or
reference, Maya will attempt to place all nodes from the imported or referenced file directly into the root (default)
name space, without invoking any name clash resolution algorithms. If the names of any of the new objects already
exist in the root namespace, then errors will result. The user of this flag is responsible for creating a name clash
resolution mechanism outside of Maya to avoid such errors. Note:This flag is intended only for use with custom file
translators written through the API. Use at your own risk.
- deferReference:
When used in conjunction with the -reference flag, this flag determines if the reference is loaded, or if loading is
deferred.C: The default is false.Q: When queried, this flag returns true if the reference is deferred, or false if the
reference is not deferred. If this is used with -rfn/referenceNode, the -rfn flag must come before -q.
- groupReference:
Used only with the -r or the -i flag. Used to group all the imported/referenced items under a single transform.
- groupName:
Used only with the -gr flag. Optionally used to set the name of the transform node that the imported/referenced items
will be grouped under.
- renameAll:
If true, rename all newly-created nodes, not just those whose names clash with existing nodes. Only available with
-i/import.
- renamingPrefix:
The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.
- swapNamespace:
Can only be used in conjunction with the -r/reference or -i/import flags. This flag will replace any occurrences of a
given namespace to an alternate specified namespace. This namespace swapwill occur as the file is referenced in. It
takes in two string arguments. The first argument specifies the namespace to replace. The second argument specifies the
replacement namespace. Use of this flag, implicitly enables the use of namespaces and cannot be used with
deferReference.
- returnNewNodes:
Used to control the return value in open, import, loadReference, and reference operations. It will force the file
command to return a list of new nodes added to the current scene.
- preserveReferences:
Modifies the various import/export flags such that references are imported/exported as actual references rather than
copies of those references.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
importFile
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def importFile(filepath, **kwargs):
'\n Import the specified file. Returns the name of the imported file. \n \n Flags:\n - loadNoReferences:\n This flag is obsolete and has been replaced witht the loadReferenceDepth flag. When used with the -open flag, no\n references will be loaded. When used with -i/import, -r/reference or -lr/loadReference flags, will load the top-most\n reference only.\n - loadReferenceDepth:\n Used to specify which references should be loaded. Valid types are all, noneand topOnly, which will load all references,\n no references and top-level references only, respectively. May only be used with the -o/open, -i/import, -r/reference or\n -lr/loadReference flags. When noneis used with -lr/loadReference, only path validation is performed. This can be used to\n replace a reference without triggering reload. Not using loadReferenceDepth will load references in the same loaded or\n unloaded state that they were in when the file was saved. Additionally, the -lr/loadReference flag supports a fourth\n type, asPrefs. This will force any nested references to be loaded according to the state (if any) stored in the current\n scene file, rather than according to the state saved in the reference file itself.\n - defaultNamespace:\n Use the default name space for import and referencing. This is an advanced option. If set, then on import or\n reference, Maya will attempt to place all nodes from the imported or referenced file directly into the root (default)\n name space, without invoking any name clash resolution algorithms. If the names of any of the new objects already\n exist in the root namespace, then errors will result. The user of this flag is responsible for creating a name clash\n resolution mechanism outside of Maya to avoid such errors. Note:This flag is intended only for use with custom file\n translators written through the API. Use at your own risk.\n - deferReference:\n When used in conjunction with the -reference flag, this flag determines if the reference is loaded, or if loading is\n deferred.C: The default is false.Q: When queried, this flag returns true if the reference is deferred, or false if the\n reference is not deferred. If this is used with -rfn/referenceNode, the -rfn flag must come before -q.\n - groupReference:\n Used only with the -r or the -i flag. Used to group all the imported/referenced items under a single transform.\n - groupName:\n Used only with the -gr flag. Optionally used to set the name of the transform node that the imported/referenced items\n will be grouped under.\n - renameAll:\n If true, rename all newly-created nodes, not just those whose names clash with existing nodes. Only available with\n -i/import.\n - renamingPrefix:\n The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.\n - swapNamespace:\n Can only be used in conjunction with the -r/reference or -i/import flags. This flag will replace any occurrences of a\n given namespace to an alternate specified namespace. This namespace swapwill occur as the file is referenced in. It\n takes in two string arguments. The first argument specifies the namespace to replace. The second argument specifies the\n replacement namespace. Use of this flag, implicitly enables the use of namespaces and cannot be used with\n deferReference.\n - returnNewNodes:\n Used to control the return value in open, import, loadReference, and reference operations. It will force the file\n command to return a list of new nodes added to the current scene.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def importFile(filepath, **kwargs):
'\n Import the specified file. Returns the name of the imported file. \n \n Flags:\n - loadNoReferences:\n This flag is obsolete and has been replaced witht the loadReferenceDepth flag. When used with the -open flag, no\n references will be loaded. When used with -i/import, -r/reference or -lr/loadReference flags, will load the top-most\n reference only.\n - loadReferenceDepth:\n Used to specify which references should be loaded. Valid types are all, noneand topOnly, which will load all references,\n no references and top-level references only, respectively. May only be used with the -o/open, -i/import, -r/reference or\n -lr/loadReference flags. When noneis used with -lr/loadReference, only path validation is performed. This can be used to\n replace a reference without triggering reload. Not using loadReferenceDepth will load references in the same loaded or\n unloaded state that they were in when the file was saved. Additionally, the -lr/loadReference flag supports a fourth\n type, asPrefs. This will force any nested references to be loaded according to the state (if any) stored in the current\n scene file, rather than according to the state saved in the reference file itself.\n - defaultNamespace:\n Use the default name space for import and referencing. This is an advanced option. If set, then on import or\n reference, Maya will attempt to place all nodes from the imported or referenced file directly into the root (default)\n name space, without invoking any name clash resolution algorithms. If the names of any of the new objects already\n exist in the root namespace, then errors will result. The user of this flag is responsible for creating a name clash\n resolution mechanism outside of Maya to avoid such errors. Note:This flag is intended only for use with custom file\n translators written through the API. Use at your own risk.\n - deferReference:\n When used in conjunction with the -reference flag, this flag determines if the reference is loaded, or if loading is\n deferred.C: The default is false.Q: When queried, this flag returns true if the reference is deferred, or false if the\n reference is not deferred. If this is used with -rfn/referenceNode, the -rfn flag must come before -q.\n - groupReference:\n Used only with the -r or the -i flag. Used to group all the imported/referenced items under a single transform.\n - groupName:\n Used only with the -gr flag. Optionally used to set the name of the transform node that the imported/referenced items\n will be grouped under.\n - renameAll:\n If true, rename all newly-created nodes, not just those whose names clash with existing nodes. Only available with\n -i/import.\n - renamingPrefix:\n The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.\n - swapNamespace:\n Can only be used in conjunction with the -r/reference or -i/import flags. This flag will replace any occurrences of a\n given namespace to an alternate specified namespace. This namespace swapwill occur as the file is referenced in. It\n takes in two string arguments. The first argument specifies the namespace to replace. The second argument specifies the\n replacement namespace. Use of this flag, implicitly enables the use of namespaces and cannot be used with\n deferReference.\n - returnNewNodes:\n Used to control the return value in open, import, loadReference, and reference operations. It will force the file\n command to return a list of new nodes added to the current scene.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Import the specified file. Returns the name of the imported file.
Flags:
- loadNoReferences:
This flag is obsolete and has been replaced witht the loadReferenceDepth flag. When used with the -open flag, no
references will be loaded. When used with -i/import, -r/reference or -lr/loadReference flags, will load the top-most
reference only.
- loadReferenceDepth:
Used to specify which references should be loaded. Valid types are all, noneand topOnly, which will load all references,
no references and top-level references only, respectively. May only be used with the -o/open, -i/import, -r/reference or
-lr/loadReference flags. When noneis used with -lr/loadReference, only path validation is performed. This can be used to
replace a reference without triggering reload. Not using loadReferenceDepth will load references in the same loaded or
unloaded state that they were in when the file was saved. Additionally, the -lr/loadReference flag supports a fourth
type, asPrefs. This will force any nested references to be loaded according to the state (if any) stored in the current
scene file, rather than according to the state saved in the reference file itself.
- defaultNamespace:
Use the default name space for import and referencing. This is an advanced option. If set, then on import or
reference, Maya will attempt to place all nodes from the imported or referenced file directly into the root (default)
name space, without invoking any name clash resolution algorithms. If the names of any of the new objects already
exist in the root namespace, then errors will result. The user of this flag is responsible for creating a name clash
resolution mechanism outside of Maya to avoid such errors. Note:This flag is intended only for use with custom file
translators written through the API. Use at your own risk.
- deferReference:
When used in conjunction with the -reference flag, this flag determines if the reference is loaded, or if loading is
deferred.C: The default is false.Q: When queried, this flag returns true if the reference is deferred, or false if the
reference is not deferred. If this is used with -rfn/referenceNode, the -rfn flag must come before -q.
- groupReference:
Used only with the -r or the -i flag. Used to group all the imported/referenced items under a single transform.
- groupName:
Used only with the -gr flag. Optionally used to set the name of the transform node that the imported/referenced items
will be grouped under.
- renameAll:
If true, rename all newly-created nodes, not just those whose names clash with existing nodes. Only available with
-i/import.
- renamingPrefix:
The string to use as a prefix for all objects from this file. This flag has been replaced by -ns/namespace.
- swapNamespace:
Can only be used in conjunction with the -r/reference or -i/import flags. This flag will replace any occurrences of a
given namespace to an alternate specified namespace. This namespace swapwill occur as the file is referenced in. It
takes in two string arguments. The first argument specifies the namespace to replace. The second argument specifies the
replacement namespace. Use of this flag, implicitly enables the use of namespaces and cannot be used with
deferReference.
- returnNewNodes:
Used to control the return value in open, import, loadReference, and reference operations. It will force the file
command to return a list of new nodes added to the current scene.
- preserveReferences:
Modifies the various import/export flags such that references are imported/exported as actual references rather than
copies of those references.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
a7ee22f8de2d0d6de43680f0e1191cbfee9333058eff6070d43d0cbbaba5b02d
|
def exportAll(exportPath, **kwargs):
'\n Export everything into a single file. Returns the name of the exported file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
Export everything into a single file. Returns the name of the exported file.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- preserveReferences:
Modifies the various import/export flags such that references are imported/exported as actual references rather than
copies of those references.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`
|
mayaSDK/pymel/core/system.py
|
exportAll
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def exportAll(exportPath, **kwargs):
'\n Export everything into a single file. Returns the name of the exported file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass
|
def exportAll(exportPath, **kwargs):
'\n Export everything into a single file. Returns the name of the exported file. \n \n Flags:\n - force:\n Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force\n remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the\n root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without\n prompting a dialog that warns user about the lost of edits.\n - preserveReferences:\n Modifies the various import/export flags such that references are imported/exported as actual references rather than\n copies of those references.\n - type:\n Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,\n audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of\n file types that match this file.\n \n Derived from mel command `maya.cmds.file`\n '
pass<|docstring|>Export everything into a single file. Returns the name of the exported file.
Flags:
- force:
Force an action to take place. (new, open, save, remove reference, unload reference) Used with removeReference to force
remove reference namespace even if it has contents. Cannot be used with removeReference if the reference resides in the
root namespace. Used with unloadReference to force unload reference even if the reference node is locked, without
prompting a dialog that warns user about the lost of edits.
- preserveReferences:
Modifies the various import/export flags such that references are imported/exported as actual references rather than
copies of those references.
- type:
Set the type of this file. By default this can be any one of: mayaAscii, mayaBinary, mel, OBJ, directory, plug-in,
audio, move, EPS, Adobe(R) Illustrator(R), imageplug-ins may define their own types as well.Return a string array of
file types that match this file.
Derived from mel command `maya.cmds.file`<|endoftext|>
|
8c7a33cd63b6944cd75ba90ce8df4342c6aeae27129f9dd38dc5ab9371fede40
|
def clearCache(*args, **kwargs):
'\n Even though dependency graph values are computed or dirty they may still occupy space temporarily within the nodes.\n This command goes in to all of the data that can be regenerated if required and removes it from the caches (datablocks),\n thus clearing up space in memory.\n \n Flags:\n - allNodes : all (bool) [create]\n If toggled then all nodes in the graph are cleared. Otherwise only those nodes that are selected are cleared.\n \n - computed : c (bool) [create]\n If toggled then remove all data that is computable. (Warning: If the data is requested for redraw then the recompute\n will immediately fill the data back in.)\n \n - dirty : d (bool) [create]\n If toggled then remove all heavy data that is dirty. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.clearCache`\n '
pass
|
Even though dependency graph values are computed or dirty they may still occupy space temporarily within the nodes.
This command goes in to all of the data that can be regenerated if required and removes it from the caches (datablocks),
thus clearing up space in memory.
Flags:
- allNodes : all (bool) [create]
If toggled then all nodes in the graph are cleared. Otherwise only those nodes that are selected are cleared.
- computed : c (bool) [create]
If toggled then remove all data that is computable. (Warning: If the data is requested for redraw then the recompute
will immediately fill the data back in.)
- dirty : d (bool) [create]
If toggled then remove all heavy data that is dirty. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.clearCache`
|
mayaSDK/pymel/core/system.py
|
clearCache
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def clearCache(*args, **kwargs):
'\n Even though dependency graph values are computed or dirty they may still occupy space temporarily within the nodes.\n This command goes in to all of the data that can be regenerated if required and removes it from the caches (datablocks),\n thus clearing up space in memory.\n \n Flags:\n - allNodes : all (bool) [create]\n If toggled then all nodes in the graph are cleared. Otherwise only those nodes that are selected are cleared.\n \n - computed : c (bool) [create]\n If toggled then remove all data that is computable. (Warning: If the data is requested for redraw then the recompute\n will immediately fill the data back in.)\n \n - dirty : d (bool) [create]\n If toggled then remove all heavy data that is dirty. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.clearCache`\n '
pass
|
def clearCache(*args, **kwargs):
'\n Even though dependency graph values are computed or dirty they may still occupy space temporarily within the nodes.\n This command goes in to all of the data that can be regenerated if required and removes it from the caches (datablocks),\n thus clearing up space in memory.\n \n Flags:\n - allNodes : all (bool) [create]\n If toggled then all nodes in the graph are cleared. Otherwise only those nodes that are selected are cleared.\n \n - computed : c (bool) [create]\n If toggled then remove all data that is computable. (Warning: If the data is requested for redraw then the recompute\n will immediately fill the data back in.)\n \n - dirty : d (bool) [create]\n If toggled then remove all heavy data that is dirty. Flag can have multiple arguments,\n passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.clearCache`\n '
pass<|docstring|>Even though dependency graph values are computed or dirty they may still occupy space temporarily within the nodes.
This command goes in to all of the data that can be regenerated if required and removes it from the caches (datablocks),
thus clearing up space in memory.
Flags:
- allNodes : all (bool) [create]
If toggled then all nodes in the graph are cleared. Otherwise only those nodes that are selected are cleared.
- computed : c (bool) [create]
If toggled then remove all data that is computable. (Warning: If the data is requested for redraw then the recompute
will immediately fill the data back in.)
- dirty : d (bool) [create]
If toggled then remove all heavy data that is dirty. Flag can have multiple arguments,
passed either as a tuple or a list.
Derived from mel command `maya.cmds.clearCache`<|endoftext|>
|
a58f907511fd63e356f5dcae41d5a3bf407b1cb0335061070c0323983a962065
|
def openMayaPref(*args, **kwargs):
"\n Set or query API preferences.\n \n Flags:\n - errlog : el (bool) [create,query,edit]\n toggles whether or not an error log of failed API method calls will be created. When set to true, a file called\n OpenMayaErrorLogwill be created in Maya's current working directory. Each time an API method fails, a detailed\n description of the error will be written to the file along with a mini-stack trace that indicates the routine that\n called the failing method. Defaults to false(off).\n \n - lazyLoad : lz (bool) [create,query,edit]\n toggles whether or not plugins will be loaded with the RTLD_NOW flag or the RTLD_LAZY flag of dlopen(3C). If set to\n true, RTLD_LAZY will be used. In this mode references to functions that cannot be resolved at load time will not be\n considered an error. However, if one of these symbols is actually dereferenced by the plug-in at run time, Maya will\n crash. Defaults to false(off).\n \n - oldPluginWarning : ow (bool) [create,query,edit]\n toggles whether or not loadPlugin will generate a warning when plug-ins are loaded that were compiled against an older,\n and possibly incompatible Maya release. Defaults to true(on). Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.openMayaPref`\n "
pass
|
Set or query API preferences.
Flags:
- errlog : el (bool) [create,query,edit]
toggles whether or not an error log of failed API method calls will be created. When set to true, a file called
OpenMayaErrorLogwill be created in Maya's current working directory. Each time an API method fails, a detailed
description of the error will be written to the file along with a mini-stack trace that indicates the routine that
called the failing method. Defaults to false(off).
- lazyLoad : lz (bool) [create,query,edit]
toggles whether or not plugins will be loaded with the RTLD_NOW flag or the RTLD_LAZY flag of dlopen(3C). If set to
true, RTLD_LAZY will be used. In this mode references to functions that cannot be resolved at load time will not be
considered an error. However, if one of these symbols is actually dereferenced by the plug-in at run time, Maya will
crash. Defaults to false(off).
- oldPluginWarning : ow (bool) [create,query,edit]
toggles whether or not loadPlugin will generate a warning when plug-ins are loaded that were compiled against an older,
and possibly incompatible Maya release. Defaults to true(on). Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.openMayaPref`
|
mayaSDK/pymel/core/system.py
|
openMayaPref
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def openMayaPref(*args, **kwargs):
"\n Set or query API preferences.\n \n Flags:\n - errlog : el (bool) [create,query,edit]\n toggles whether or not an error log of failed API method calls will be created. When set to true, a file called\n OpenMayaErrorLogwill be created in Maya's current working directory. Each time an API method fails, a detailed\n description of the error will be written to the file along with a mini-stack trace that indicates the routine that\n called the failing method. Defaults to false(off).\n \n - lazyLoad : lz (bool) [create,query,edit]\n toggles whether or not plugins will be loaded with the RTLD_NOW flag or the RTLD_LAZY flag of dlopen(3C). If set to\n true, RTLD_LAZY will be used. In this mode references to functions that cannot be resolved at load time will not be\n considered an error. However, if one of these symbols is actually dereferenced by the plug-in at run time, Maya will\n crash. Defaults to false(off).\n \n - oldPluginWarning : ow (bool) [create,query,edit]\n toggles whether or not loadPlugin will generate a warning when plug-ins are loaded that were compiled against an older,\n and possibly incompatible Maya release. Defaults to true(on). Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.openMayaPref`\n "
pass
|
def openMayaPref(*args, **kwargs):
"\n Set or query API preferences.\n \n Flags:\n - errlog : el (bool) [create,query,edit]\n toggles whether or not an error log of failed API method calls will be created. When set to true, a file called\n OpenMayaErrorLogwill be created in Maya's current working directory. Each time an API method fails, a detailed\n description of the error will be written to the file along with a mini-stack trace that indicates the routine that\n called the failing method. Defaults to false(off).\n \n - lazyLoad : lz (bool) [create,query,edit]\n toggles whether or not plugins will be loaded with the RTLD_NOW flag or the RTLD_LAZY flag of dlopen(3C). If set to\n true, RTLD_LAZY will be used. In this mode references to functions that cannot be resolved at load time will not be\n considered an error. However, if one of these symbols is actually dereferenced by the plug-in at run time, Maya will\n crash. Defaults to false(off).\n \n - oldPluginWarning : ow (bool) [create,query,edit]\n toggles whether or not loadPlugin will generate a warning when plug-ins are loaded that were compiled against an older,\n and possibly incompatible Maya release. Defaults to true(on). Flag can have multiple arguments, passed\n either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.openMayaPref`\n "
pass<|docstring|>Set or query API preferences.
Flags:
- errlog : el (bool) [create,query,edit]
toggles whether or not an error log of failed API method calls will be created. When set to true, a file called
OpenMayaErrorLogwill be created in Maya's current working directory. Each time an API method fails, a detailed
description of the error will be written to the file along with a mini-stack trace that indicates the routine that
called the failing method. Defaults to false(off).
- lazyLoad : lz (bool) [create,query,edit]
toggles whether or not plugins will be loaded with the RTLD_NOW flag or the RTLD_LAZY flag of dlopen(3C). If set to
true, RTLD_LAZY will be used. In this mode references to functions that cannot be resolved at load time will not be
considered an error. However, if one of these symbols is actually dereferenced by the plug-in at run time, Maya will
crash. Defaults to false(off).
- oldPluginWarning : ow (bool) [create,query,edit]
toggles whether or not loadPlugin will generate a warning when plug-ins are loaded that were compiled against an older,
and possibly incompatible Maya release. Defaults to true(on). Flag can have multiple arguments, passed
either as a tuple or a list.
Derived from mel command `maya.cmds.openMayaPref`<|endoftext|>
|
11554208509d1c556463f52f322c83b2a5b28f4dba7700af84077918e190350f
|
def moduleInfo(*args, **kwargs):
'\n Returns information on modules found by Maya.\n \n Flags:\n - definition : d (bool) [create]\n Returns module definition file name for the module specified by the -moduleName parameter.\n \n - listModules : lm (bool) [create]\n Returns an array containing the names of all currently loaded modules.\n \n - moduleName : mn (unicode) [create]\n The name of the module whose information you want to retrieve. Has to be used with either -definition / -path / -version\n flags.\n \n - path : p (bool) [create]\n Returns the module path for the module specified by the -moduleName parameter.\n \n - version : v (bool) [create]\n Returns the module version for the module specified by the -moduleName parameter. Flag\n can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.moduleInfo`\n '
pass
|
Returns information on modules found by Maya.
Flags:
- definition : d (bool) [create]
Returns module definition file name for the module specified by the -moduleName parameter.
- listModules : lm (bool) [create]
Returns an array containing the names of all currently loaded modules.
- moduleName : mn (unicode) [create]
The name of the module whose information you want to retrieve. Has to be used with either -definition / -path / -version
flags.
- path : p (bool) [create]
Returns the module path for the module specified by the -moduleName parameter.
- version : v (bool) [create]
Returns the module version for the module specified by the -moduleName parameter. Flag
can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.moduleInfo`
|
mayaSDK/pymel/core/system.py
|
moduleInfo
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def moduleInfo(*args, **kwargs):
'\n Returns information on modules found by Maya.\n \n Flags:\n - definition : d (bool) [create]\n Returns module definition file name for the module specified by the -moduleName parameter.\n \n - listModules : lm (bool) [create]\n Returns an array containing the names of all currently loaded modules.\n \n - moduleName : mn (unicode) [create]\n The name of the module whose information you want to retrieve. Has to be used with either -definition / -path / -version\n flags.\n \n - path : p (bool) [create]\n Returns the module path for the module specified by the -moduleName parameter.\n \n - version : v (bool) [create]\n Returns the module version for the module specified by the -moduleName parameter. Flag\n can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.moduleInfo`\n '
pass
|
def moduleInfo(*args, **kwargs):
'\n Returns information on modules found by Maya.\n \n Flags:\n - definition : d (bool) [create]\n Returns module definition file name for the module specified by the -moduleName parameter.\n \n - listModules : lm (bool) [create]\n Returns an array containing the names of all currently loaded modules.\n \n - moduleName : mn (unicode) [create]\n The name of the module whose information you want to retrieve. Has to be used with either -definition / -path / -version\n flags.\n \n - path : p (bool) [create]\n Returns the module path for the module specified by the -moduleName parameter.\n \n - version : v (bool) [create]\n Returns the module version for the module specified by the -moduleName parameter. Flag\n can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.moduleInfo`\n '
pass<|docstring|>Returns information on modules found by Maya.
Flags:
- definition : d (bool) [create]
Returns module definition file name for the module specified by the -moduleName parameter.
- listModules : lm (bool) [create]
Returns an array containing the names of all currently loaded modules.
- moduleName : mn (unicode) [create]
The name of the module whose information you want to retrieve. Has to be used with either -definition / -path / -version
flags.
- path : p (bool) [create]
Returns the module path for the module specified by the -moduleName parameter.
- version : v (bool) [create]
Returns the module version for the module specified by the -moduleName parameter. Flag
can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.moduleInfo`<|endoftext|>
|
b6b1e5279e59d33a0e6fee5c746c7c918646b6af723b16ec8ce9596d788e45ee
|
def launch(*args, **kwargs):
"\n Launch the appropriate application to open the document, web page or directory specified.\n \n Flags:\n - directory : dir (unicode) [create]\n A directory.\n \n - movie : mov (unicode) [create]\n A movie file. The only acceptable movie file formats are MPEG, Quicktime, and Windows Media file. The file's name must\n end with .mpg, .mpeg, .mp4, .wmv, .mov, or .qt.\n \n - pdfFile : pdf (unicode) [create]\n A PDF (Portable Document Format) document. The file's name must end with .pdf.\n \n - webPage : web (unicode) [create]\n A web page. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.launch`\n "
pass
|
Launch the appropriate application to open the document, web page or directory specified.
Flags:
- directory : dir (unicode) [create]
A directory.
- movie : mov (unicode) [create]
A movie file. The only acceptable movie file formats are MPEG, Quicktime, and Windows Media file. The file's name must
end with .mpg, .mpeg, .mp4, .wmv, .mov, or .qt.
- pdfFile : pdf (unicode) [create]
A PDF (Portable Document Format) document. The file's name must end with .pdf.
- webPage : web (unicode) [create]
A web page. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.launch`
|
mayaSDK/pymel/core/system.py
|
launch
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def launch(*args, **kwargs):
"\n Launch the appropriate application to open the document, web page or directory specified.\n \n Flags:\n - directory : dir (unicode) [create]\n A directory.\n \n - movie : mov (unicode) [create]\n A movie file. The only acceptable movie file formats are MPEG, Quicktime, and Windows Media file. The file's name must\n end with .mpg, .mpeg, .mp4, .wmv, .mov, or .qt.\n \n - pdfFile : pdf (unicode) [create]\n A PDF (Portable Document Format) document. The file's name must end with .pdf.\n \n - webPage : web (unicode) [create]\n A web page. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.launch`\n "
pass
|
def launch(*args, **kwargs):
"\n Launch the appropriate application to open the document, web page or directory specified.\n \n Flags:\n - directory : dir (unicode) [create]\n A directory.\n \n - movie : mov (unicode) [create]\n A movie file. The only acceptable movie file formats are MPEG, Quicktime, and Windows Media file. The file's name must\n end with .mpg, .mpeg, .mp4, .wmv, .mov, or .qt.\n \n - pdfFile : pdf (unicode) [create]\n A PDF (Portable Document Format) document. The file's name must end with .pdf.\n \n - webPage : web (unicode) [create]\n A web page. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.launch`\n "
pass<|docstring|>Launch the appropriate application to open the document, web page or directory specified.
Flags:
- directory : dir (unicode) [create]
A directory.
- movie : mov (unicode) [create]
A movie file. The only acceptable movie file formats are MPEG, Quicktime, and Windows Media file. The file's name must
end with .mpg, .mpeg, .mp4, .wmv, .mov, or .qt.
- pdfFile : pdf (unicode) [create]
A PDF (Portable Document Format) document. The file's name must end with .pdf.
- webPage : web (unicode) [create]
A web page. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.launch`<|endoftext|>
|
a2ab8acba877f7e44e8a02c027d2c96a9b2f000fd047b20212172bf815717415
|
def error(*args, **kwargs):
"\n The error command is provided so that the user can issue error messages from his/her scripts and control execution in\n the event of runtime errors. The string argument is displayed in the command window (or stdout if running in batch\n mode) after being prefixed with an error message heading and surrounded by //. The error command also causes execution\n to terminate with an error. Using error is like raising an exception because the error will propagate up through the\n call chain. You can use catch to handle the error from the caller side. If you don't want execution to end, then you\n probably want to use the warning command instead.\n \n Flags:\n - noContext : n (bool) [create]\n Do not include the context information with the error message.\n \n - showLineNumber : sl (bool) [create]\n Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number\n display instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.error`\n "
pass
|
The error command is provided so that the user can issue error messages from his/her scripts and control execution in
the event of runtime errors. The string argument is displayed in the command window (or stdout if running in batch
mode) after being prefixed with an error message heading and surrounded by //. The error command also causes execution
to terminate with an error. Using error is like raising an exception because the error will propagate up through the
call chain. You can use catch to handle the error from the caller side. If you don't want execution to end, then you
probably want to use the warning command instead.
Flags:
- noContext : n (bool) [create]
Do not include the context information with the error message.
- showLineNumber : sl (bool) [create]
Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number
display instead. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.error`
|
mayaSDK/pymel/core/system.py
|
error
|
FXTD-ODYSSEY/vscode-mayapy
| 20 |
python
|
def error(*args, **kwargs):
"\n The error command is provided so that the user can issue error messages from his/her scripts and control execution in\n the event of runtime errors. The string argument is displayed in the command window (or stdout if running in batch\n mode) after being prefixed with an error message heading and surrounded by //. The error command also causes execution\n to terminate with an error. Using error is like raising an exception because the error will propagate up through the\n call chain. You can use catch to handle the error from the caller side. If you don't want execution to end, then you\n probably want to use the warning command instead.\n \n Flags:\n - noContext : n (bool) [create]\n Do not include the context information with the error message.\n \n - showLineNumber : sl (bool) [create]\n Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number\n display instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.error`\n "
pass
|
def error(*args, **kwargs):
"\n The error command is provided so that the user can issue error messages from his/her scripts and control execution in\n the event of runtime errors. The string argument is displayed in the command window (or stdout if running in batch\n mode) after being prefixed with an error message heading and surrounded by //. The error command also causes execution\n to terminate with an error. Using error is like raising an exception because the error will propagate up through the\n call chain. You can use catch to handle the error from the caller side. If you don't want execution to end, then you\n probably want to use the warning command instead.\n \n Flags:\n - noContext : n (bool) [create]\n Do not include the context information with the error message.\n \n - showLineNumber : sl (bool) [create]\n Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number\n display instead. Flag can have multiple arguments, passed either as a tuple or a list.\n \n \n Derived from mel command `maya.cmds.error`\n "
pass<|docstring|>The error command is provided so that the user can issue error messages from his/her scripts and control execution in
the event of runtime errors. The string argument is displayed in the command window (or stdout if running in batch
mode) after being prefixed with an error message heading and surrounded by //. The error command also causes execution
to terminate with an error. Using error is like raising an exception because the error will propagate up through the
call chain. You can use catch to handle the error from the caller side. If you don't want execution to end, then you
probably want to use the warning command instead.
Flags:
- noContext : n (bool) [create]
Do not include the context information with the error message.
- showLineNumber : sl (bool) [create]
Obsolete. Will be deleted in the next version of Maya. Use the checkbox in the script editor that enables line number
display instead. Flag can have multiple arguments, passed either as a tuple or a list.
Derived from mel command `maya.cmds.error`<|endoftext|>
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.